---
url: 'https://gramio.dev/api/auto-retry.md'
---
[GramIO API Reference](../../../index.md) / @gramio/auto-retry/dist

# @gramio/auto-retry/dist

## Functions

### autoRetry()

> **autoRetry**(): [`Plugin`](../../../gramio/classes/Plugin.md)

Defined in: auto-retry/index.d.ts:27

A plugin that catches errors with the `retry_after` field (**rate limit** errors), **waits** for the specified time and **repeats** the API request.

#### Returns

[`Plugin`](../../../gramio/classes/Plugin.md)

#### Example

```ts
import { Bot } from "gramio";
import { autoRetry } from "@gramio/auto-retry";

const bot = new Bot(process.env.TOKEN!)
    .extend(autoRetry())
    .command("start", async (context) => {
        for (let index = 0; index < 100; index++) {
            await context.reply(`some ${index}`);
        }
    })
    .onStart(console.log);

bot.start();
```

---

---
url: 'https://gramio.dev/api/autoload.md'
---
[GramIO API Reference](../../../index.md) / @gramio/autoload/dist

# @gramio/autoload/dist

## Interfaces

| Interface | Description |
| ------ | ------ |
| [AutoloadOptions](interfaces/AutoloadOptions.md) | Options for [autoload](#autoload) plugin with options for Options | fdir and PicomatchOptions | picomatch |
| [AutoloadOptionsPathParams](interfaces/AutoloadOptionsPathParams.md) | Params that used in [onLoad](interfaces/AutoloadOptions.md#onload) and [onFinish](interfaces/AutoloadOptions.md#onfinish) hooks |

## Functions

### autoload()

> **autoload**(`options?`): `Promise`<[`Plugin`](../../../gramio/classes/Plugin.md)<{ }, [`DeriveDefinitions`](../../../gramio/type-aliases/DeriveDefinitions.md), { }>>

Defined in: autoload/index.d.ts:81

Autoload commands plugin for GramIO.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`AutoloadOptions`](interfaces/AutoloadOptions.md) |

#### Returns

`Promise`<[`Plugin`](../../../gramio/classes/Plugin.md)<{ }, [`DeriveDefinitions`](../../../gramio/type-aliases/DeriveDefinitions.md), { }>>

#### Example

## Register the plugin

```ts
// index.ts
import { Bot } from "gramio";
import { autoload } from "@gramio/autoload";

const bot = new Bot(process.env.TOKEN as string)
    .extend(autoload())
    .onStart(console.log);

bot.start();

export type BotType = typeof bot;
```

## Create command

```ts
// commands/command.ts
import type { BotType } from "..";

export default (bot: BotType) =>
    bot.command("start", (context) => context.send("hello!"));
```

---

---
url: 'https://gramio.dev/api/callback-data.md'
---
[GramIO API Reference](../../../index.md) / @gramio/callback-data/dist

# @gramio/callback-data/dist

## Classes

| Class | Description |
| ------ | ------ |
| [CallbackData](classes/CallbackData.md) | Class-helper that construct schema and serialize/deserialize with [CallbackData.pack](classes/CallbackData.md#pack) and [CallbackData.unpack](classes/CallbackData.md#unpack) methods |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [InferDataPack](type-aliases/InferDataPack.md) | - |
| [InferDataUnpack](type-aliases/InferDataUnpack.md) | - |
| [SafeUnpackResult](type-aliases/SafeUnpackResult.md) | - |

---

---
url: 'https://gramio.dev/extend/composer.md'
---

# @gramio/composer

[![npm](https://img.shields.io/npm/v/@gramio/composer?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/composer)
[![JSR](https://jsr.io/badges/@gramio/composer)](https://jsr.io/@gramio/composer)

`@gramio/composer` is the general-purpose, type-safe middleware composition library that powers GramIO's internals. If you're writing a plugin, building a framework on top of GramIO, or just want to understand how context enrichment works — this is the place to start.

## Installation

::: pm-add @gramio/composer
:::

## Core Concepts

A `Composer` is a chainable middleware pipeline. Each method registers a new middleware step and returns the (updated) composer for chaining:

```ts
import { Composer } from "@gramio/composer";

const app = new Composer<{ request: Request }>()
    .use(logger)
    .derive(fetchUser)
    .guard(isAuthenticated)
    .use(handler);
```

### use()

Register raw middleware. The handler receives `(context, next)` and must call `next()` to continue the chain:

```ts
app.use(async (ctx, next) => {
    console.log("before");
    await next();
    console.log("after");
});
```

### derive()

Enriches context with computed values. The returned object is merged into the context for all downstream middleware:

```ts
app.derive(async (ctx) => {
    const user = await db.findUser(ctx.userId);
    return { user };
});
// ctx.user is now available downstream
```

### decorate()

Like `derive()`, but for static values that don't need per-request computation. Assigns the object once at registration time and reuses the same reference — zero function call overhead:

```ts
app.decorate({ db: myDatabase, config: appConfig });
// ctx.db and ctx.config available on every request, no overhead
```

Supports scoping with `{ as: "scoped" }` or `{ as: "global" }` to propagate through `extend()`.

### guard()

Only continues the chain if the predicate returns true:

```ts
app.guard((ctx) => ctx.user.isAdmin);
// Subsequent middleware only runs for admins
```

### when()

Build-time conditional middleware registration. The condition is evaluated once at startup, not per-request. Properties added inside the block are typed as `Partial` (optional):

```ts
const app = new Composer()
    .when(process.env.NODE_ENV !== "production", (c) =>
        c.use(verboseLogger)
    )
    .when(config.features.analytics, (c) =>
        c.derive(() => ({ analytics: createAnalyticsClient() }))
    );
```

Differences from `branch()`:

* `when()` — condition evaluated **once at startup** (build-time)
* `branch()` — condition evaluated **on every request** (runtime)

Nested `when()` blocks work. Dedup keys, error handlers, and error definitions propagate from the conditional block.

## Observability

### inspect()

Returns a read-only snapshot of all registered middleware with metadata:

```ts
const app = new Composer()
    .derive(function getUser() { return { user: "alice" }; })
    .guard(function isAdmin() { return true; })
    .use(async function handleRequest(_, next) { return next(); });

app.inspect();
// [
//   { index: 0, type: "derive", name: "getUser", scope: "local" },
//   { index: 1, type: "guard", name: "isAdmin", scope: "local" },
//   { index: 2, type: "use", name: "handleRequest", scope: "local" },
// ]
```

When a named plugin is extended, the `plugin` field shows the source:

```ts
const auth = new Composer({ name: "auth" })
    .derive(function getUser() { return { user: "alice" }; })
    .as("scoped");

new Composer().extend(auth).inspect();
// [{ index: 0, type: "derive", name: "getUser", scope: "local", plugin: "auth" }]
```

### trace()

Opt-in per-middleware instrumentation hook. Zero overhead when not used — middleware functions are passed through unwrapped when no tracer is set:

```ts
app.trace((entry, ctx) => {
    const span = tracer.startSpan(`${entry.type}:${entry.name ?? "anonymous"}`);
    span.setAttributes({
        "middleware.index": entry.index,
        "middleware.scope": entry.scope,
        ...(entry.plugin && { "middleware.plugin": entry.plugin }),
    });
    return (error) => {
        if (error) span.recordException(error as Error);
        span.end();
    };
});
```

The `TraceHandler` callback:

1. Is called before each middleware executes with `MiddlewareInfo` and context
2. May return a cleanup function `(error?: unknown) => void`
3. Cleanup is called after middleware completes (with no args on success, with the error on failure)
4. Errors still propagate to `onError` after cleanup

## Scope System

The scope system controls how middleware propagates when one composer extends another:

| Scope | Behavior |
|-------|---------|
| `"local"` (default) | Isolated inside an isolation wrapper — context does not leak to parent |
| `"scoped"` | Adds directly to parent as a local entry — visible to parent's downstream middleware |
| `"global"` | Adds to parent as global — continues propagating through further `extend()` calls |

Promote a whole composer to a scope with `.as()`:

```ts
const plugin = new Composer({ name: "auth" })
    .derive(function getUser() { return { user: "alice" }; })
    .as("scoped"); // everything in this composer is scoped

app.extend(plugin); // getUser is now visible in app's downstream
```

## Error Handling

```ts
class NotFoundError extends Error {}

const app = new Composer()
    .error("NotFound", NotFoundError)
    .onError(({ error, kind, context }) => {
        if (kind === "NotFound") {
            context.send("Resource not found");
            return "handled";
        }
    })
    .use(() => { throw new NotFoundError("Item missing"); });
```

Multiple `onError()` handlers are evaluated in order — the first to return a non-undefined value wins. Errors without a matching handler are logged via `console.error`.

## Plugin Development

For plugin authors, `@gramio/composer` is the foundation of GramIO's `Plugin` class. The concepts map directly:

```ts
import { Plugin } from "gramio";

// Plugin uses the same Composer API internally
const myPlugin = new Plugin("my-plugin")
    .decorate({ db: myDatabase })        // static enrichment
    .derive(async () => ({ user: ... })) // per-request enrichment
    .on("message", handler);            // event handler
```

For advanced plugin creation that needs custom shorthand methods or observability, work directly with `@gramio/composer`.

## createComposer() — Building Custom Frameworks

If you're building a framework on top of `@gramio/composer` and need custom shorthand methods (like GramIO's own `hears()`, `command()`, `reaction()`), use `createComposer()`:

```ts
import { createComposer, eventTypes } from "@gramio/composer";

const { Composer } = createComposer({
    discriminator: (ctx: BaseCtx) => ctx.updateType,
    types: eventTypes<{ message: MessageCtx; callback_query: CallbackCtx }>(),
    methods: {
        hears(trigger: RegExp | string, handler: (ctx: MessageCtx) => unknown) {
            return this.on("message", (ctx, next) => {
                const text = ctx.text;
                if (typeof trigger === "string" ? text === trigger : trigger.test(text ?? ""))
                    return handler(ctx);
                return next();
            });
        },
        command(cmd: string, handler: (ctx: MessageCtx) => unknown) {
            return this.on("message", (ctx, next) => {
                if (ctx.text?.startsWith(`/${cmd}`)) return handler(ctx);
                return next();
            });
        },
    },
});

// Custom methods survive through all chain operations:
const app = new Composer()
    .hears(/hello/, h1)  // custom method
    .on("message", h2)   // built-in — TMethods still preserved
    .hears(/bye/, h3);   // custom method still available
```

**`types` + `eventTypes()`**: TypeScript cannot partially infer type arguments. The `types` phantom field with `eventTypes()` helper lets you specify `TEventMap` without losing `TMethods` inference:

```ts
// Instead of explicit type parameters (can't infer TMethods):
createComposer<BaseCtx, { message: MessageCtx }>({ ... })

// Use the phantom types pattern:
createComposer({
    discriminator: (ctx: BaseCtx) => ctx.updateType,
    types: eventTypes<{ message: MessageCtx }>(), // inferred, not explicit
    methods: { /* TMethods inferred from here */ },
})
```

A runtime conflict check throws if a `methods` key collides with a built-in method name.

### `defineComposerMethods()` — generic custom methods with derives

When custom methods have **generic signatures** that need to capture accumulated derives, use `defineComposerMethods()` first. TypeScript cannot infer generic method signatures when `TMethods` is nested inside the return type of `createComposer`, so the helper is required:

```ts
import { defineComposerMethods, createComposer } from "@gramio/composer";
import type { ComposerLike, ContextOf, Middleware } from "@gramio/composer";

const methods = defineComposerMethods({
    command<TThis extends ComposerLike<TThis>>(
        this: TThis,
        name: string,
        handler: Middleware<MessageCtx & ContextOf<TThis>>,
    ): TThis {
        return this.on("message", (ctx, next) => {
            if (ctx.text === `/${name}`) return handler(ctx, next);
            return next();
        });
    },
});

const { Composer } = createComposer<BaseCtx, EventMap, typeof methods>({
    discriminator: (ctx) => ctx.updateType,
    methods,
});

// Derives flow into the handler automatically — zero annotation:
new Composer()
    .derive(() => ({ user: { id: 1, name: "Alice" } }))
    .command("start", (ctx) => {
        ctx.user.id;  // ✅ typed — inferred via ContextOf<TThis>
        ctx.text;     // ✅ from MessageCtx
    });
```

## `ContextOf<T>` — extract the current context type

Extracts `TOut` (the fully accumulated context after all `derive()`/`decorate()` calls) from a Composer or EventComposer instance type. Most useful in `defineComposerMethods()` custom method signatures so that derives flow in automatically:

```ts
import type { ContextOf } from "@gramio/composer";

type Ctx = ContextOf<typeof myComposer>;
// Ctx = accumulated context including all derive() results
```

## `EventContextOf<T, E>` — per-event context type

Extracts the context for a **specific event** from a composer instance, including both global and per-event derives:

```ts
import type { EventContextOf } from "@gramio/composer";

// Per-event derive: only visible in 'message' handlers
composer.derive(['message'], () => ({ messageData: "..." }));

type MessageCtx = EventContextOf<typeof composer, 'message'>;
// Includes both global derives AND messageData
```

## `ComposerLike<T>` — minimal structural type for `this` constraints

A minimal interface `{ on(event: any, handler: any): T }` used as an F-bounded constraint on `TThis` in custom methods. Makes `this.on(...)` fully typed and return `TThis` without casts.

## Macro System

Register reusable behaviors that handlers activate declaratively via an options object. Useful for cross-cutting concerns like authentication, rate limiting, validation — without polluting handler bodies with boilerplate checks:

```ts
// Register a macro
const app = new Composer().macro("adminOnly", {
    preHandler: async (ctx, next) => {
        if (ctx.userId !== ADMIN_ID) return ctx.reply("Admins only");
        return next();
    },
});

// Activate per handler via options:
app.on("message", handler, { adminOnly: true });
app.on("callback_query", handler, { adminOnly: true });
```

`macro()` accepts either:

* **Plain `MacroHooks` object** — for boolean shorthand (`{ adminOnly: true }`)
* **`(opts) => MacroHooks` function** — for parameterized options (`{ throttle: { limit: 3 } }`)

`MacroHooks` has:

* `preHandler` — middleware that runs before the handler
* `derive` — context enrichment function; returning `void` stops the chain

---

---
url: 'https://gramio.dev/api/composer.md'
---
[GramIO API Reference](../../../index.md) / @gramio/composer/dist

# @gramio/composer/dist

## Classes

| Class | Description |
| ------ | ------ |
| [Composer](classes/Composer.md) | - |
| [EventQueue](classes/EventQueue.md) | Concurrent event queue with graceful shutdown support. Processes events in parallel (like an event loop), not sequentially. |

## Interfaces

| Interface | Description |
| ------ | ------ |
| [ComposerOptions](interfaces/ComposerOptions.md) | Composer constructor options |
| [ContextCallback](interfaces/ContextCallback.md) | Marker type for context-aware callbacks in macro options. The framework replaces this with the actual handler context type at the call site. |
| [EventComposer](interfaces/EventComposer.md) | EventComposer interface — Composer + .on() + per-event derive tracking + custom methods |
| [EventComposerConstructor](interfaces/EventComposerConstructor.md) | - |
| [MacroHooks](interfaces/MacroHooks.md) | What a macro can return when activated |
| [MiddlewareInfo](interfaces/MiddlewareInfo.md) | Read-only projection of a middleware entry for inspect()/trace() |
| [RouteBuilder](interfaces/RouteBuilder.md) | Route builder passed to the builder-callback overload of route() |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [CompatibleEvents](type-aliases/CompatibleEvents.md) | Given an event map and a Narrowing type, yields the union of event names whose context type contains all keys from Narrowing. |
| [ComposedMiddleware](type-aliases/ComposedMiddleware.md) | Composed middleware: next is optional (acts as terminal continuation) |
| [ComposerLike](type-aliases/ComposerLike.md) | Minimal structural type for constraining `this` in custom composer methods. |
| [ContextOf](type-aliases/ContextOf.md) | Extracts the current accumulated context type (`TOut`) from an EventComposer or Composer instance type. |
| [DeriveFromOptions](type-aliases/DeriveFromOptions.md) | Collects all derive types from macros that are activated in `TOptions`. The result is intersected into the handler's context type. |
| [DeriveHandler](type-aliases/DeriveHandler.md) | Function that computes additional context properties |
| [ErrorHandler](type-aliases/ErrorHandler.md) | Error handler receives an object with error, context, and resolved kind |
| [EventContextOf](type-aliases/EventContextOf.md) | Extracts the context type for a specific event from an EventComposer instance, combining global `TOut` (like `ContextOf`) **and** per-event `TDerives[E]`. |
| [HandlerOptions](type-aliases/HandlerOptions.md) | Builds the `options` parameter type for handler methods. Includes `preHandler` plus all registered macro option types with ContextCallback markers replaced by `TBaseCtx`. |
| [LazyFactory](type-aliases/LazyFactory.md) | Lazy middleware factory — called per invocation |
| [MacroDef](type-aliases/MacroDef.md) | A macro definition: either a function accepting options, or a plain hooks object (boolean shorthand). |
| [MacroDefinitions](type-aliases/MacroDefinitions.md) | Registry of named macro definitions |
| [MacroDeriveType](type-aliases/MacroDeriveType.md) | Extract the derive (context enrichment) type from a macro |
| [MacroOptionType](type-aliases/MacroOptionType.md) | Extract the options type a macro accepts (boolean for shorthand macros) |
| [MaybeArray](type-aliases/MaybeArray.md) | Single value or array |
| [Middleware](type-aliases/Middleware.md) | Middleware function: receives context and next |
| [MiddlewareType](type-aliases/MiddlewareType.md) | Which method created a middleware entry |
| [Next](type-aliases/Next.md) | next() continuation function |
| [RouteHandler](type-aliases/RouteHandler.md) | Route handler: single middleware, array, or Composer instance |
| [Scope](type-aliases/Scope.md) | Scope level for middleware propagation |
| [TraceHandler](type-aliases/TraceHandler.md) | Trace callback invoked on middleware enter; returns cleanup called on exit |
| [WithCtx](type-aliases/WithCtx.md) | Recursively replaces all `ContextCallback` occurrences in `T` with `(ctx: TCtx) => unknown`. |

## Variables

### noopNext

> `const` **noopNext**: [`Next`](type-aliases/Next.md)

Defined in: composer/index.d.ts:496

No-op next function: () => Promise.resolve()

***

### skip

> `const` **skip**: [`Middleware`](type-aliases/Middleware.md)<`any`>

Defined in: composer/index.d.ts:498

Pass-through middleware: calls next() immediately

***

### stop

> `const` **stop**: [`Middleware`](type-aliases/Middleware.md)<`any`>

Defined in: composer/index.d.ts:500

Terminal middleware: does NOT call next()

## Functions

### buildFromOptions()

> **buildFromOptions**<`TCtx`>(`macros`, `options`, `handler`): [`Middleware`](type-aliases/Middleware.md)<`TCtx`>

Defined in: composer/index.d.ts:493

Composes a handler with macro hooks and preHandlers from an options object.

Execution order:

1. `options.preHandler` array (explicit guards — user controls order)
2. Per-macro in options property order:
   a. macro.preHandler (guard middleware)
   b. macro.derive (context enrichment; void return = stop chain)
3. Main handler

#### Type Parameters

| Type Parameter |
| ------ |
| `TCtx` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `macros` | `Record`<`string`, [`MacroDef`](type-aliases/MacroDef.md)<`any`, `any`>> |
| `options` | `Record`<`string`, `unknown`> |
| `handler` | [`Middleware`](type-aliases/Middleware.md)<`TCtx`> |

#### Returns

[`Middleware`](type-aliases/Middleware.md)<`TCtx`>

***

### compose()

> **compose**<`T`>(`middlewares`): [`ComposedMiddleware`](type-aliases/ComposedMiddleware.md)<`T`>

Defined in: composer/index.d.ts:132

Compose an array of middleware functions into a single middleware.
Koa-style onion model: each middleware receives (context, next).

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `middlewares` | [`Middleware`](type-aliases/Middleware.md)<`T`>\[] |

#### Returns

[`ComposedMiddleware`](type-aliases/ComposedMiddleware.md)<`T`>

***

### createComposer()

> **createComposer**<`TBase`, `TEventMap`, `TMethods`>(`config`): `object`

Defined in: composer/index.d.ts:473

Creates a configured Composer class with type-safe .on() event discrimination.

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `TBase` *extends* `object` | - |
| `TEventMap` *extends* `Record`<`string`, `TBase`> | `object` |
| `TMethods` *extends* `Record`<`string`, (...`args`) => `any`> | `object` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | { `discriminator`: (`context`) => `string`; `methods?`: `TMethods` & `ThisType`<[`EventComposer`](interfaces/EventComposer.md)<`TBase`, `TEventMap`, `TBase`, `TBase`, { }, { }, `TMethods`, { }> & `TMethods`>; `types?`: `TEventMap`; } |
| `config.discriminator` | (`context`) => `string` |
| `config.methods?` | `TMethods` & `ThisType`<[`EventComposer`](interfaces/EventComposer.md)<`TBase`, `TEventMap`, `TBase`, `TBase`, { }, { }, `TMethods`, { }> & `TMethods`> |
| `config.types?` | `TEventMap` |

#### Returns

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `compose()` | <`T`>(`middlewares`) => [`ComposedMiddleware`](type-aliases/ComposedMiddleware.md)<`T`> | composer/index.d.ts:479 |
| `Composer` | [`EventComposerConstructor`](interfaces/EventComposerConstructor.md)<`TBase`, `TEventMap`, `TMethods`> | composer/index.d.ts:478 |
| `EventQueue` | *typeof* [`EventQueue`](classes/EventQueue.md) | composer/index.d.ts:480 |

***

### defineComposerMethods()

> **defineComposerMethods**<`TMethods`>(`methods`): `TMethods`

Defined in: composer/index.d.ts:454

Helper to define custom composer methods with full TypeScript inference.

TypeScript cannot infer generic method signatures when they're passed directly
inside `createComposer({ methods: { ... } })` because `TMethods` is buried
inside the nested return type `{ Composer: EventComposerConstructor<..., TMethods> }`.

This helper has return type `TMethods` directly — which lets TypeScript preserve
generic method signatures. Pass the result (via `typeof`) as the 3rd type argument
to `createComposer`:

#### Type Parameters

| Type Parameter |
| ------ |
| `TMethods` *extends* `Record`<`string`, (...`args`) => `any`> |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `methods` | `TMethods` |

#### Returns

`TMethods`

#### Example

```ts
const methods = defineComposerMethods({
  // Pattern: `this: TThis` + `ContextOf<TThis>` — zero annotation at call site
  command<TThis>(
    this: TThis,
    name: string,
    handler: Middleware<MessageCtx & ContextOf<TThis>>,
  ): TThis {
    return (this as any).on("message", (ctx: any, next: any) => {
      if (ctx.text === `/${name}`) return handler(ctx, next);
      return next();
    }) as TThis;
  },
});

const { Composer } = createComposer<Base, EventMap, typeof methods>({
  discriminator: (ctx) => ctx.updateType,
  methods,
});

// No annotation needed — derives flow in automatically:
new Composer()
  .derive(() => ({ user: { id: 1 } }))
  .command("start", (ctx) => ctx.user.id); // ✅
```

***

### eventTypes()

> **eventTypes**<`TEventMap`>(): `TEventMap`

Defined in: composer/index.d.ts:469

Phantom type carrier for event map inference.
Returns `undefined` at runtime — exists purely for type-level inference
so that `TEventMap` can be inferred from the `types` config field.

#### Type Parameters

| Type Parameter |
| ------ |
| `TEventMap` *extends* `Record`<`string`, `any`> |

#### Returns

`TEventMap`

#### Example

```ts
const { Composer } = createComposer({
  discriminator: (ctx: BaseCtx) => ctx.updateType,
  types: eventTypes<EventMap>(),
  methods: { hears(trigger) { return this.on("message", ...); } },
});
```

---

---
url: 'https://gramio.dev/api/contexts.md'
---
[GramIO API Reference](../../../index.md) / @gramio/contexts/dist

# @gramio/contexts/dist

## Enumerations

| Enumeration | Description |
| ------ | ------ |
| [ChatType](enumerations/ChatType.md) | Enum of ChatType property |
| [EntityType](enumerations/EntityType.md) | Enum of EntityType property |
| [PollType](enumerations/PollType.md) | Enum of PollType property |

## Classes

| Class | Description |
| ------ | ------ |
| [AcceptedGiftTypes](classes/AcceptedGiftTypes.md) | This object describes the types of gifts that can be gifted to a user or a chat. |
| [AnimationAttachment](classes/AnimationAttachment.md) | This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound). |
| [Attachment](classes/Attachment.md) | Simple attachment |
| [AudioAttachment](classes/AudioAttachment.md) | This object represents an audio file to be treated as music by the Telegram clients. |
| [BackgroundFillFreeformGradient](classes/BackgroundFillFreeformGradient.md) | The background is a freeform gradient that rotates after every message in the chat. |
| [BackgroundFillGradient](classes/BackgroundFillGradient.md) | The background is a gradient fill. |
| [BackgroundFillSolid](classes/BackgroundFillSolid.md) | The background is filled using the selected color. |
| [BackgroundTypeChatTheme](classes/BackgroundTypeChatTheme.md) | The background is taken directly from a built-in chat theme. |
| [BackgroundTypeFill](classes/BackgroundTypeFill.md) | The background is automatically filled based on the selected colors. |
| [BackgroundTypePattern](classes/BackgroundTypePattern.md) | The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user. |
| [BackgroundTypeWallpaper](classes/BackgroundTypeWallpaper.md) | The background is a wallpaper in the JPEG format. |
| [Birthdate](classes/Birthdate.md) | Describes the birthdate of a user. |
| [BoostAddedContext](classes/BoostAddedContext.md) | This object represents a service message about a forum topic closed in the chat. Currently holds no information. |
| [BotCommand](classes/BotCommand.md) | This object represents a bot command |
| [BotDescription](classes/BotDescription.md) | This object represents the bot's description. |
| [BotShortDescription](classes/BotShortDescription.md) | This object represents the bot's short description. |
| [BusinessBotRights](classes/BusinessBotRights.md) | Represents the rights of a business bot. |
| [BusinessConnection](classes/BusinessConnection.md) | Describes the connection of the bot with a business account. |
| [BusinessConnectionContext](classes/BusinessConnectionContext.md) | This object Describes the connection of the bot with a business account. |
| [BusinessIntro](classes/BusinessIntro.md) | Contains information about the start page settings of a Telegram Business account. |
| [BusinessLocation](classes/BusinessLocation.md) | Contains information about the location of a Telegram Business account. |
| [BusinessMessagesDeleted](classes/BusinessMessagesDeleted.md) | Describes the connection of the bot with a business account. |
| [BusinessMessagesDeletedContext](classes/BusinessMessagesDeletedContext.md) | This object represents a boost added to a chat or changed. |
| [BusinessOpeningHours](classes/BusinessOpeningHours.md) | [Documentation](https://core.telegram.org/bots/api/#businessopeninghours) |
| [BusinessOpeningHoursInterval](classes/BusinessOpeningHoursInterval.md) | Describes an interval of time during which a business is open. |
| [CallbackGame](classes/CallbackGame.md) | A placeholder, currently holds no information. |
| [CallbackQuery](classes/CallbackQuery.md) | This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline\_message\_id will be present. Exactly one of the fields `data` or `game_short_name` will be present. |
| [CallbackQueryContext](classes/CallbackQueryContext.md) | Called when `callback_query` event occurs |
| [Chat](classes/Chat.md) | This object represents a chat. |
| [ChatActionMixin](classes/ChatActionMixin.md) | Main base context |
| [ChatAdministratorRights](classes/ChatAdministratorRights.md) | Represents the rights of an administrator in a chat. |
| [ChatBackground](classes/ChatBackground.md) | This object represents a chat background. |
| [ChatBackgroundSetContext](classes/ChatBackgroundSetContext.md) | This object represents a service message about chat background set. |
| [ChatBoost](classes/ChatBoost.md) | This object contains information about a chat boost. |
| [ChatBoostAdded](classes/ChatBoostAdded.md) | This object represents a service message about a user boosting a chat. |
| [ChatBoostContext](classes/ChatBoostContext.md) | This object represents a boost added to a chat or changed. |
| [ChatBoostRemoved](classes/ChatBoostRemoved.md) | This object represents a boost added to a chat or changed. |
| [ChatBoostSourceGiftCode](classes/ChatBoostSourceGiftCode.md) | The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription. |
| [ChatBoostSourceGiveaway](classes/ChatBoostSourceGiveaway.md) | The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription. |
| [ChatBoostSourcePremium](classes/ChatBoostSourcePremium.md) | The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user. |
| [ChatBoostUpdated](classes/ChatBoostUpdated.md) | This object represents a boost added to a chat or changed. |
| [ChatControlMixin](classes/ChatControlMixin.md) | This object represents a mixin that is responsible for all the chat management methods |
| [ChatFullInfo](classes/ChatFullInfo.md) | This object contains full information about a chat. |
| [ChatInviteControlMixin](classes/ChatInviteControlMixin.md) | This object represents a mixin that works with all `*ChatInviteLink` methods |
| [ChatInviteLink](classes/ChatInviteLink.md) | Represents an invite link for a chat. |
| [ChatJoinRequest](classes/ChatJoinRequest.md) | Represents a join request sent to a chat. |
| [ChatJoinRequestContext](classes/ChatJoinRequestContext.md) | Represents a join request sent to a chat. |
| [ChatLocation](classes/ChatLocation.md) | Represents a location to which a chat is connected. |
| [ChatMember](classes/ChatMember.md) | This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported: - `ChatMemberOwner` - `ChatMemberAdministrator` - `ChatMemberMember` - `ChatMemberRestricted` - `ChatMemberLeft` - `ChatMemberBanned` |
| [ChatMemberContext](classes/ChatMemberContext.md) | This object represents changes in the status of a chat member. |
| [ChatMemberControlMixin](classes/ChatMemberControlMixin.md) | This object represents a mixin that is able to control member's rights |
| [ChatMemberUpdated](classes/ChatMemberUpdated.md) | This object represents changes in the status of a chat member. |
| [ChatOwnerChanged](classes/ChatOwnerChanged.md) | Describes a service message about an ownership change in the chat. |
| [ChatOwnerChangedContext](classes/ChatOwnerChangedContext.md) | This object represents a service message about an ownership change in the chat. |
| [ChatOwnerLeft](classes/ChatOwnerLeft.md) | Describes a service message about the chat owner leaving the chat. |
| [ChatOwnerLeftContext](classes/ChatOwnerLeftContext.md) | This object represents a service message about the chat owner leaving the chat. |
| [ChatPermissions](classes/ChatPermissions.md) | Describes actions that a non-administrator user is allowed to take in a chat. |
| [ChatPhoto](classes/ChatPhoto.md) | This object represents a chat photo. |
| [ChatSenderControlMixin](classes/ChatSenderControlMixin.md) | This object is a mixin that does all the chat-sender stuff, right? |
| [ChatShared](classes/ChatShared.md) | This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button. |
| [ChatSharedContext](classes/ChatSharedContext.md) | This object contains information about the chat whose identifier was shared with the bot using a `KeyboardButtonRequestChat` button. |
| [Checklist](classes/Checklist.md) | Describes a checklist. |
| [ChecklistTask](classes/ChecklistTask.md) | Describes a task in a checklist. |
| [ChecklistTasksAdded](classes/ChecklistTasksAdded.md) | Describes a service message about tasks added to a checklist. |
| [ChecklistTasksAddedContext](classes/ChecklistTasksAddedContext.md) | This object represents a service message about checklist tasks added. |
| [ChecklistTasksDone](classes/ChecklistTasksDone.md) | Describes a service message about checklist tasks marked as done or not done. |
| [ChecklistTasksDoneContext](classes/ChecklistTasksDoneContext.md) | This object represents a service message about checklist tasks done. |
| [ChosenInlineResult](classes/ChosenInlineResult.md) | Represents a result of an inline query that was chosen by the user and sent to their chat partner. |
| [ChosenInlineResultContext](classes/ChosenInlineResultContext.md) | The result of an inline query that was chosen by a user and sent to their chat partner |
| [CloneMixin](classes/CloneMixin.md) | This object represents a mixin which has `clone(options?)` method |
| [Contact](classes/Contact.md) | This object represents a phone contact. |
| [ContactAttachment](classes/ContactAttachment.md) | This object represents a phone contact. |
| [Context](classes/Context.md) | Main base context |
| [DeleteChatPhotoContext](classes/DeleteChatPhotoContext.md) | Service message: the chat photo was deleted |
| [Dice](classes/Dice.md) | This object represents an animated emoji that displays a random value. |
| [DirectMessagePriceChanged](classes/DirectMessagePriceChanged.md) | Describes a service message about a change in the price of direct messages sent to a channel chat. |
| [DirectMessagePriceChangedContext](classes/DirectMessagePriceChangedContext.md) | This object represents a service message about direct message price changed. |
| [DirectMessagesTopic](classes/DirectMessagesTopic.md) | Describes a topic of a direct messages chat. |
| [DocumentAttachment](classes/DocumentAttachment.md) | This object represents a general file (as opposed to photos, voice messages and audio files). |
| [DownloadMixin](classes/DownloadMixin.md) | This object represents a mixin that can be used to download media files |
| [EncryptedCredentials](classes/EncryptedCredentials.md) | Contains data required for decrypting and authenticatin `EncryptedPassportElement`. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes. |
| [EncryptedPassportElement](classes/EncryptedPassportElement.md) | Contains information about documents or other Telegram Passport elements shared with the bot by the user. |
| [ExternalReplyInfo](classes/ExternalReplyInfo.md) | This object contains information about a message that is being replied to, which may come from another chat or forum topic. |
| [File](classes/File.md) | This object represents a file ready to be downloaded. The file can be downloaded via the link `https://api.telegram.org/file/bot<token>/<file_path>`. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling `getFile`. |
| [FileAttachment](classes/FileAttachment.md) | Attachment with `fileId` and `fileUniqueId` properties |
| [ForumMixin](classes/ForumMixin.md) | This object represents a mixin that's used in all topic-related updates |
| [ForumTopicClosed](classes/ForumTopicClosed.md) | This object represents a service message about a forum topic closed in the chat. Currently holds no information. |
| [ForumTopicClosedContext](classes/ForumTopicClosedContext.md) | This object represents a service message about a forum topic closed in the chat. Currently holds no information. |
| [ForumTopicCreated](classes/ForumTopicCreated.md) | This object represents a service message about a new forum topic created in the chat. |
| [ForumTopicCreatedContext](classes/ForumTopicCreatedContext.md) | This object represents a service message about a new forum topic created in the chat. |
| [ForumTopicEdited](classes/ForumTopicEdited.md) | This object represents a service message about an edited forum topic. |
| [ForumTopicEditedContext](classes/ForumTopicEditedContext.md) | This object represents a service message about an edited forum topic. |
| [ForumTopicReopened](classes/ForumTopicReopened.md) | This object represents a service message about an edited forum topic. |
| [ForumTopicReopenedContext](classes/ForumTopicReopenedContext.md) | This object represents a service message about a forum topic reopened in the chat. Currently holds no information. |
| [Game](classes/Game.md) | This object represents a game. |
| [GeneralForumTopicHidden](classes/GeneralForumTopicHidden.md) | This object represents a service message about General forum topic hidden in the chat. Currently holds no information. |
| [GeneralForumTopicHiddenContext](classes/GeneralForumTopicHiddenContext.md) | This object represents a service message about General forum topic hidden in the chat. Currently holds no information. |
| [GeneralForumTopicUnhidden](classes/GeneralForumTopicUnhidden.md) | This object represents a service message about General forum topic unhidden in the chat. Currently holds no information. |
| [GeneralForumTopicUnhiddenContext](classes/GeneralForumTopicUnhiddenContext.md) | This object represents a service message about General forum topic unhidden in the chat. Currently holds no information. |
| [Gift](classes/Gift.md) | Describes a service message about a regular gift that was sent or received. |
| [GiftBackground](classes/GiftBackground.md) | This object describes the background of a gift. |
| [GiftContext](classes/GiftContext.md) | This object contains information about the chat whose identifier was shared with the bot using a `KeyboardButtonRequestChat` button. |
| [GiftInfo](classes/GiftInfo.md) | Describes a service message about a regular gift that was sent or received. |
| [GiftUpgradeSentContext](classes/GiftUpgradeSentContext.md) | This object represents a service message about an upgrade of a gift that was purchased after the gift was sent. |
| [Giveaway](classes/Giveaway.md) | This object represents a message about a scheduled giveaway. |
| [GiveawayCompleted](classes/GiveawayCompleted.md) | This object represents a service message about the completion of a giveaway without public winners. |
| [GiveawayCompletedContext](classes/GiveawayCompletedContext.md) | This object represents a service message about the creation of a scheduled giveaway. Currently holds no information. |
| [GiveawayCreated](classes/GiveawayCreated.md) | This object represents a service message about the creation of a scheduled giveaway. Currently holds no information. |
| [GiveawayCreatedContext](classes/GiveawayCreatedContext.md) | This object represents a service message about the creation of a scheduled giveaway. |
| [GiveawayWinners](classes/GiveawayWinners.md) | This object represents a message about the completion of a giveaway with public winners. |
| [GiveawayWinnersContext](classes/GiveawayWinnersContext.md) | This object represents a message about the completion of a giveaway with public winners. |
| [GroupChatCreatedContext](classes/GroupChatCreatedContext.md) | service message: the group has been created |
| [InaccessibleMessage](classes/InaccessibleMessage.md) | This object describes a message that was deleted or is otherwise inaccessible to the bot. |
| [InlineKeyboardButton](classes/InlineKeyboardButton.md) | This object represents one button of an inline keyboard. You must use exactly one of the optional fields. |
| [InlineKeyboardMarkup](classes/InlineKeyboardMarkup.md) | This object represents an inline keyboard that appears right next to the message it belongs to. |
| [InlineQuery](classes/InlineQuery.md) | This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results. |
| [InlineQueryContext](classes/InlineQueryContext.md) | This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results. |
| [InlineQueryResultLocation](classes/InlineQueryResultLocation.md) | Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the location. |
| [InputChecklist](classes/InputChecklist.md) | Describes a checklist to create. |
| [InputChecklistTask](classes/InputChecklistTask.md) | Describes a task to add to a checklist. |
| [InputLocationMessageContent](classes/InputLocationMessageContent.md) | Represents the [content](https://core.telegram.org/bots/api/#inputmessagecontent) of a location message to be sent as the result of an inline query. |
| [InputPollOption](classes/InputPollOption.md) | This object contains information about one answer option in a poll to send. |
| [Invoice](classes/Invoice.md) | This object contains basic information about an invoice. |
| [InvoiceContext](classes/InvoiceContext.md) | Message is an invoice for a [payment](https://core.telegram.org/bots/api/#payments), information about the invoice. [More about payments »](https://core.telegram.org/bots/api/#payments) |
| [LeftChatMemberContext](classes/LeftChatMemberContext.md) | A member was removed from the group, information about them (this member may be the bot itself) |
| [LinkPreviewOptions](classes/LinkPreviewOptions.md) | Describes the options used for link preview generation. |
| [Location](classes/Location.md) | This object represents a point on the map. |
| [LocationAttachment](classes/LocationAttachment.md) | This object represents a point on the map. |
| [LocationContext](classes/LocationContext.md) | This object represents a point on the map. |
| [LoginUrl](classes/LoginUrl.md) | This object represents a parameter of the inline keyboard button used to automatically authorize a user. |
| [MaskPosition](classes/MaskPosition.md) | This object describes the position on faces where a mask should be placed by default. |
| [MenuButton](classes/MenuButton.md) | This object describes the bot's menu button in a private chat. |
| [Message](classes/Message.md) | This object represents a message. |
| [MessageAutoDeleteTimerChanged](classes/MessageAutoDeleteTimerChanged.md) | This object represents a service message about a change in auto-delete timer settings |
| [MessageAutoDeleteTimerChangedContext](classes/MessageAutoDeleteTimerChangedContext.md) | This object represents a service message about a change in auto-delete timer settings. |
| [MessageContext](classes/MessageContext.md) | Called when `message` event occurs |
| [MessageEntity](classes/MessageEntity.md) | This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc. |
| [MessageId](classes/MessageId.md) | This object represents a unique message identifier. |
| [MessageOriginChannel](classes/MessageOriginChannel.md) | The message was originally sent to a channel chat. |
| [MessageOriginChat](classes/MessageOriginChat.md) | The message was originally sent on behalf of a chat to a group chat. |
| [MessageOriginHiddenUser](classes/MessageOriginHiddenUser.md) | The message was originally sent by an unknown user. |
| [MessageOriginUser](classes/MessageOriginUser.md) | The message was originally sent by a known user. |
| [MessageReactionContext](classes/MessageReactionContext.md) | This object represents a change of a reaction on a message performed by a user. |
| [MessageReactionCountContext](classes/MessageReactionCountContext.md) | This object represents reaction changes on a message with anonymous reactions. |
| [MessageReactionCountUpdated](classes/MessageReactionCountUpdated.md) | This object represents reaction changes on a message with anonymous reactions. |
| [MessageReactionUpdated](classes/MessageReactionUpdated.md) | This object represents a change of a reaction on a message performed by a user. |
| [MigrateFromChatIdContext](classes/MigrateFromChatIdContext.md) | The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. |
| [MigrateToChatIdContext](classes/MigrateToChatIdContext.md) | The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. |
| [NewChatMembersContext](classes/NewChatMembersContext.md) | New members that were added to the group or supergroup and information about them (the bot itself may be one of these members) |
| [NewChatPhotoContext](classes/NewChatPhotoContext.md) | A chat photo was change to this value |
| [NewChatTitleContext](classes/NewChatTitleContext.md) | A chat title was changed to this value |
| [NodeMixin](classes/NodeMixin.md) | This object represents a mixin which has `id` field and can invoke `id`-dependent methods |
| [OrderInfo](classes/OrderInfo.md) | This object represents information about an order. |
| [PaidMediaInfo](classes/PaidMediaInfo.md) | Describes the paid media added to a message. |
| [PaidMediaPhoto](classes/PaidMediaPhoto.md) | The paid media is a photo. |
| [PaidMediaPreview](classes/PaidMediaPreview.md) | The paid media isn't available before the payment. |
| [PaidMediaPurchasedContext](classes/PaidMediaPurchasedContext.md) | This object contains information about a paid media purchase. |
| [PaidMediaVideo](classes/PaidMediaVideo.md) | The paid media is a video. |
| [PaidMessagePriceChangedContext](classes/PaidMessagePriceChangedContext.md) | Describes a service message about a change in the price of paid messages within a chat. |
| [PassportData](classes/PassportData.md) | Contains information about Telegram Passport data shared with the bot by the user. |
| [PassportDataContext](classes/PassportDataContext.md) | Describes Telegram Passport data shared with the bot by the user. |
| [PassportFile](classes/PassportFile.md) | This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB. |
| [PhotoAttachment](classes/PhotoAttachment.md) | This object represents a photo file with it's sizes |
| [PhotoSize](classes/PhotoSize.md) | This object represents one size of a photo or a file / sticker thumbnail |
| [PinnedMessageContext](classes/PinnedMessageContext.md) | Specified message was pinned. Note that the Message object in this field will not contain further *reply\_to\_message* fields even if it itself is a reply. |
| [PinsMixin](classes/PinsMixin.md) | This object represents a mixin that ensures you have methods to pin/unpin messages in the chat |
| [Poll](classes/Poll.md) | This object contains information about a poll. |
| [PollAnswer](classes/PollAnswer.md) | This object represents an answer of a user in a non-anonymous poll. |
| [PollAnswerContext](classes/PollAnswerContext.md) | This object represents an answer of a user in a non-anonymous poll. |
| [PollAttachment](classes/PollAttachment.md) | This object contains information about a poll. |
| [PollContext](classes/PollContext.md) | This object contains information about a poll. |
| [PollOption](classes/PollOption.md) | This object contains information about one answer option in a poll. |
| [PreCheckoutQuery](classes/PreCheckoutQuery.md) | This object contains information about an incoming pre-checkout query. |
| [PreCheckoutQueryContext](classes/PreCheckoutQueryContext.md) | This object contains information about an incoming pre-checkout query. |
| [ProximityAlertTriggered](classes/ProximityAlertTriggered.md) | This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user. |
| [ProximityAlertTriggeredContext](classes/ProximityAlertTriggeredContext.md) | This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user. |
| [ReactionCount](classes/ReactionCount.md) | Represents a reaction added to a message along with the number of times it was added. |
| [ReactionTypeCustomEmoji](classes/ReactionTypeCustomEmoji.md) | The reaction is based on a custom emoji. |
| [ReactionTypeEmoji](classes/ReactionTypeEmoji.md) | The reaction is based on an emoji. |
| [ReactionTypePaid](classes/ReactionTypePaid.md) | The reaction is paid. |
| [RefundedPayment](classes/RefundedPayment.md) | This object contains basic information about a refunded payment. |
| [RefundedPaymentContext](classes/RefundedPaymentContext.md) | This object contains basic information about a successful payment. |
| [RemovedChatBoostContext](classes/RemovedChatBoostContext.md) | This object represents a boost removed from a chat. |
| [SendMixin](classes/SendMixin.md) | This object represents a mixin which can invoke `chatId`/`senderId`-dependent methods |
| [SentWebAppMessage](classes/SentWebAppMessage.md) | Contains information about an inline message sent by a Web App on behalf of a user. |
| [SharedUser](classes/SharedUser.md) | This object contains information about the user whose identifier was shared with the bot using a `KeyboardButtonRequestUser` button. |
| [ShippingAddress](classes/ShippingAddress.md) | This object represents a shipping address. |
| [ShippingQuery](classes/ShippingQuery.md) | This object contains information about an incoming shipping query. |
| [ShippingQueryContext](classes/ShippingQueryContext.md) | This object contains information about an incoming shipping query. |
| [StickerAttachment](classes/StickerAttachment.md) | This object represents a sticker. |
| [StickerSet](classes/StickerSet.md) | This object represents a sticker set. |
| [Story](classes/Story.md) | This object represents a story. |
| [StoryAttachment](classes/StoryAttachment.md) | This object represents a story. |
| [SuccessfulPayment](classes/SuccessfulPayment.md) | This object contains basic information about a successful payment. |
| [SuccessfulPaymentContext](classes/SuccessfulPaymentContext.md) | This object contains basic information about a successful payment. |
| [SuggestedPostApprovalFailed](classes/SuggestedPostApprovalFailed.md) | Describes a service message about the failed approval of a suggested post. |
| [SuggestedPostApprovalFailedContext](classes/SuggestedPostApprovalFailedContext.md) | This object represents a service message about the failed approval of a suggested post. |
| [SuggestedPostApproved](classes/SuggestedPostApproved.md) | Describes a service message about the approval of a suggested post. |
| [SuggestedPostApprovedContext](classes/SuggestedPostApprovedContext.md) | This object represents a service message about the approval of a suggested post. |
| [SuggestedPostDeclined](classes/SuggestedPostDeclined.md) | Describes a service message about the rejection of a suggested post. |
| [SuggestedPostDeclinedContext](classes/SuggestedPostDeclinedContext.md) | This object represents a service message about the rejection of a suggested post. |
| [SuggestedPostInfo](classes/SuggestedPostInfo.md) | Contains information about a suggested post. |
| [SuggestedPostPaid](classes/SuggestedPostPaid.md) | Describes a service message about a successful payment for a suggested post. |
| [SuggestedPostPaidContext](classes/SuggestedPostPaidContext.md) | This object represents a service message about a successful payment for a suggested post. |
| [SuggestedPostPrice](classes/SuggestedPostPrice.md) | Describes price of a suggested post. |
| [SuggestedPostRefunded](classes/SuggestedPostRefunded.md) | Describes a service message about a payment refund for a suggested post. |
| [SuggestedPostRefundedContext](classes/SuggestedPostRefundedContext.md) | This object represents a service message about a payment refund for a suggested post. |
| [TargetMixin](classes/TargetMixin.md) | This object represents a mixin which has sender data (e.g. `senderId`, `from` etc.) |
| [TextQuote](classes/TextQuote.md) | This object contains information about the quoted part of a message that is replied to by the given message. |
| [UniqueGift](classes/UniqueGift.md) | This object describes a unique gift that was upgraded from a regular gift. |
| [UniqueGiftBackdrop](classes/UniqueGiftBackdrop.md) | This object describes the colors of the backdrop of a unique gift. |
| [UniqueGiftBackdropColors](classes/UniqueGiftBackdropColors.md) | Describes a service message about a regular gift that was sent or received. |
| [UniqueGiftColors](classes/UniqueGiftColors.md) | This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift. |
| [UniqueGiftContext](classes/UniqueGiftContext.md) | This object contains information about the chat whose identifier was shared with the bot using a `KeyboardButtonRequestChat` button. |
| [UniqueGiftInfo](classes/UniqueGiftInfo.md) | Describes a service message about a unique gift that was sent or received. |
| [UniqueGiftModel](classes/UniqueGiftModel.md) | Describes a service message about a regular gift that was sent or received. |
| [UniqueGiftSymbol](classes/UniqueGiftSymbol.md) | Describes a service message about a regular gift that was sent or received. |
| [Update](classes/Update.md) | This object represents an incoming update. |
| [User](classes/User.md) | This object represents a Telegram user or bot. |
| [UserProfileAudios](classes/UserProfileAudios.md) | This object represents the audios displayed on a user's profile. |
| [UserProfilePhotos](classes/UserProfilePhotos.md) | This object represent a user's profile pictures. |
| [UserRating](classes/UserRating.md) | This object describes the rating of a user based on their Telegram Star spendings. |
| [UsersShared](classes/UsersShared.md) | This object contains information about the user whose identifier was shared with the bot using a `KeyboardButtonRequestUser` button. |
| [UsersSharedContext](classes/UsersSharedContext.md) | This object contains information about the users whose identifiers were shared with the bot using a `KeyboardButtonRequestUsers` button. |
| [Venue](classes/Venue.md) | This object represents a venue. |
| [VenueAttachment](classes/VenueAttachment.md) | This object represents a venue. |
| [VideoAttachment](classes/VideoAttachment.md) | This object represents a video file. |
| [VideoChatEnded](classes/VideoChatEnded.md) | This object represents a service message about a video chat ended in the chat. |
| [VideoChatEndedContext](classes/VideoChatEndedContext.md) | This object represents a service message about a video chat ended in the chat. |
| [VideoChatParticipantsInvited](classes/VideoChatParticipantsInvited.md) | This object represents a service message about new members invited to a video chat. |
| [VideoChatParticipantsInvitedContext](classes/VideoChatParticipantsInvitedContext.md) | This object represents a service message about new members invited to a video chat. |
| [VideoChatScheduled](classes/VideoChatScheduled.md) | This object represents a service message about a video chat scheduled in the chat |
| [VideoChatScheduledContext](classes/VideoChatScheduledContext.md) | This object represents a service message about a video chat scheduled in the chat. |
| [VideoChatStarted](classes/VideoChatStarted.md) | This object represents a service message about a video chat started in the chat. Currently holds no information. |
| [VideoChatStartedContext](classes/VideoChatStartedContext.md) | This object represents a service message about a video chat started in the chat. |
| [VideoNoteAttachment](classes/VideoNoteAttachment.md) | This object represents a video message. |
| [VideoQuality](classes/VideoQuality.md) | This object represents a video file of a specific quality. |
| [VoiceAttachment](classes/VoiceAttachment.md) | This object represents a voice note. |
| [WebAppData](classes/WebAppData.md) | Contains data sent from a Web App to the bot. |
| [WebAppDataContext](classes/WebAppDataContext.md) | Describes data sent from a [Web App](https://core.telegram.org/bots/webapps) to the bot. |
| [WebAppInfo](classes/WebAppInfo.md) | Contains information about a Web App. |
| [WriteAccessAllowed](classes/WriteAccessAllowed.md) | This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information. |
| [WriteAccessAllowedContext](classes/WriteAccessAllowedContext.md) | This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method [requestWriteAccess](https://core.telegram.org/bots/webapps#initializing-mini-apps). |

## Interfaces

| Interface | Description |
| ------ | ------ |
| [AttachmentsMapping](interfaces/AttachmentsMapping.md) | Mapping attachments type to their structures |
| [BotLike](interfaces/BotLike.md) | The required object that the contexts are based on |
| [DefaultAttachment](interfaces/DefaultAttachment.md) | Base interface for attachment |
| [StreamMessageOptions](interfaces/StreamMessageOptions.md) | Options for SendMixin.streamMessage |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [AttachmentType](type-aliases/AttachmentType.md) | Union type of attachments type |
| [Constructor](type-aliases/Constructor.md) | Type helper constructor |
| [ContextsMapping](type-aliases/ContextsMapping.md) | Mapping events to their contexts |
| [ContextType](type-aliases/ContextType.md) | Type util to get type of Context |
| [CustomEventName](type-aliases/CustomEventName.md) | Custom Event Name |
| [GetDerives](type-aliases/GetDerives.md) | - |
| [JoinUnion](type-aliases/JoinUnion.md) | Type helper to join union type |
| [MaybeArray](type-aliases/MaybeArray.md) | Type helper to add array and non-array type |
| [MessageContextWithRequiredFrom](type-aliases/MessageContextWithRequiredFrom.md) | - |
| [MessageDraftPiece](type-aliases/MessageDraftPiece.md) | A chunk of text for streaming via sendMessageDraft |
| [MessageEventName](type-aliases/MessageEventName.md) | Union type of MessageEvent names |
| [Optional](type-aliases/Optional.md) | Make some keys optional |
| [Require](type-aliases/Require.md) | Like `Required<T>` but for specified keys of `T` |
| [RequireValue](type-aliases/RequireValue.md) | Like `Require<O, K>` but it sets `V` as the value for `K` values |
| [SoftString](type-aliases/SoftString.md) | Permits `string` but gives hints |
| [tSendAnimation](type-aliases/tSendAnimation.md) | This type represent SendAnimationParams and used by Contexts.MessageContext.sendMedia |
| [tSendAudio](type-aliases/tSendAudio.md) | This type represent SendAudioParams and used by Contexts.MessageContext.sendMedia |
| [tSendDocument](type-aliases/tSendDocument.md) | This type represent SendDocumentParams and used by Contexts.MessageContext.sendMedia |
| [tSendMethods](type-aliases/tSendMethods.md) | This Union type represent a media that can be sended and used by Contexts.MessageContext.sendMedia |
| [tSendPhoto](type-aliases/tSendPhoto.md) | This type represent SendPhotoParams and used by Contexts.MessageContext.sendMedia |
| [tSendSticker](type-aliases/tSendSticker.md) | This type represent SendStickerParams and used by Contexts.MessageContext.sendMedia |
| [tSendVideo](type-aliases/tSendVideo.md) | This type represent SendVideoParams and used by Contexts.MessageContext.sendMedia |
| [tSendVideoNote](type-aliases/tSendVideoNote.md) | This type represent SendVideoNoteParams and used by Contexts.MessageContext.sendMedia |
| [tSendVoice](type-aliases/tSendVoice.md) | This type represent SendVoiceParams and used by Contexts.MessageContext.sendMedia |
| [UpdateName](type-aliases/UpdateName.md) | Union type of Update names |

## Variables

### applyMixins()

> `const` **applyMixins**: (`derivedCtor`, `baseCtors`) => `void`

Defined in: contexts/index.d.ts:6701

Helper for construct mixins

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `derivedCtor` | `any` |
| `baseCtors` | `any`\[] |

#### Returns

`void`

***

### backgroundFillMap

> `const` **backgroundFillMap**: `object`

Defined in: contexts/index.d.ts:1023

This object describes the way a background is filled based on the selected colors. Currently, it can be one of

* [BackgroundFillSolid](https://core.telegram.org/bots/api/#backgroundfillsolid)
* [BackgroundFillGradient](https://core.telegram.org/bots/api/#backgroundfillgradient)
* [BackgroundFillFreeformGradient](https://core.telegram.org/bots/api/#backgroundfillfreeformgradient)

[Documentation](https://core.telegram.org/bots/api/#backgroundfill)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
|  `freeform_gradient` | *typeof* [`BackgroundFillFreeformGradient`](classes/BackgroundFillFreeformGradient.md) | contexts/index.d.ts:1026 |
|  `gradient` | *typeof* [`BackgroundFillGradient`](classes/BackgroundFillGradient.md) | contexts/index.d.ts:1025 |
|  `solid` | *typeof* [`BackgroundFillSolid`](classes/BackgroundFillSolid.md) | contexts/index.d.ts:1024 |

***

### backgroundTypeMap

> `const` **backgroundTypeMap**: `object`

Defined in: contexts/index.d.ts:1151

This object describes the type of a background. Currently, it can be one of

* [BackgroundTypeFill](https://core.telegram.org/bots/api/#backgroundtypefill)
* [BackgroundTypeWallpaper](https://core.telegram.org/bots/api/#backgroundtypewallpaper)
* [BackgroundTypePattern](https://core.telegram.org/bots/api/#backgroundtypepattern)
* [BackgroundTypeChatTheme](https://core.telegram.org/bots/api/#backgroundtypechattheme)

[Documentation](https://core.telegram.org/bots/api/#backgroundtype)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
|  `chat_theme` | *typeof* [`BackgroundTypeChatTheme`](classes/BackgroundTypeChatTheme.md) | contexts/index.d.ts:1155 |
|  `fill` | *typeof* [`BackgroundTypeFill`](classes/BackgroundTypeFill.md) | contexts/index.d.ts:1152 |
|  `pattern` | *typeof* [`BackgroundTypePattern`](classes/BackgroundTypePattern.md) | contexts/index.d.ts:1154 |
|  `wallpaper` | *typeof* [`BackgroundTypeWallpaper`](classes/BackgroundTypeWallpaper.md) | contexts/index.d.ts:1153 |

***

### contextsMappings

> `const` **contextsMappings**: `object`

Defined in: contexts/index.d.ts:6728

Mapping UpdateNames to their contexts

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
|  `boost_added` | *typeof* [`BoostAddedContext`](classes/BoostAddedContext.md) | contexts/index.d.ts:6761 |
|  `business_connection` | *typeof* [`BusinessConnectionContext`](classes/BusinessConnectionContext.md) | contexts/index.d.ts:6748 |
|  `business_message` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6745 |
|  `callback_query` | *typeof* [`CallbackQueryContext`](classes/CallbackQueryContext.md) | contexts/index.d.ts:6729 |
|  `channel_post` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6742 |
|  `chat_background_set` | *typeof* [`ChatBackgroundSetContext`](classes/ChatBackgroundSetContext.md) | contexts/index.d.ts:6762 |
|  `chat_boost` | *typeof* [`ChatBoostContext`](classes/ChatBoostContext.md) | contexts/index.d.ts:6797 |
|  `chat_join_request` | *typeof* [`ChatJoinRequestContext`](classes/ChatJoinRequestContext.md) | contexts/index.d.ts:6730 |
|  `chat_member` | *typeof* [`ChatMemberContext`](classes/ChatMemberContext.md) | contexts/index.d.ts:6731 |
|  `chat_owner_changed` | *typeof* [`ChatOwnerChangedContext`](classes/ChatOwnerChangedContext.md) | contexts/index.d.ts:6786 |
|  `chat_owner_left` | *typeof* [`ChatOwnerLeftContext`](classes/ChatOwnerLeftContext.md) | contexts/index.d.ts:6785 |
|  `chat_shared` | *typeof* [`ChatSharedContext`](classes/ChatSharedContext.md) | contexts/index.d.ts:6781 |
|  `checklist_tasks_added` | *typeof* [`ChecklistTasksAddedContext`](classes/ChecklistTasksAddedContext.md) | contexts/index.d.ts:6764 |
|  `checklist_tasks_done` | *typeof* [`ChecklistTasksDoneContext`](classes/ChecklistTasksDoneContext.md) | contexts/index.d.ts:6763 |
|  `chosen_inline_result` | *typeof* [`ChosenInlineResultContext`](classes/ChosenInlineResultContext.md) | contexts/index.d.ts:6733 |
|  `delete_chat_photo` | *typeof* [`DeleteChatPhotoContext`](classes/DeleteChatPhotoContext.md) | contexts/index.d.ts:6734 |
|  `deleted_business_messages` | *typeof* [`BusinessMessagesDeletedContext`](classes/BusinessMessagesDeletedContext.md) | contexts/index.d.ts:6747 |
|  `direct_message_price_changed` | *typeof* [`DirectMessagePriceChangedContext`](classes/DirectMessagePriceChangedContext.md) | contexts/index.d.ts:6765 |
|  `edited_business_message` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6746 |
|  `edited_channel_post` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6744 |
|  `edited_message` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6743 |
|  `forum_topic_closed` | *typeof* [`ForumTopicClosedContext`](classes/ForumTopicClosedContext.md) | contexts/index.d.ts:6773 |
|  `forum_topic_created` | *typeof* [`ForumTopicCreatedContext`](classes/ForumTopicCreatedContext.md) | contexts/index.d.ts:6771 |
|  `forum_topic_edited` | *typeof* [`ForumTopicEditedContext`](classes/ForumTopicEditedContext.md) | contexts/index.d.ts:6772 |
|  `forum_topic_reopened` | *typeof* [`ForumTopicReopenedContext`](classes/ForumTopicReopenedContext.md) | contexts/index.d.ts:6774 |
|  `general_forum_topic_hidden` | *typeof* [`GeneralForumTopicHiddenContext`](classes/GeneralForumTopicHiddenContext.md) | contexts/index.d.ts:6775 |
|  `general_forum_topic_unhidden` | *typeof* [`GeneralForumTopicUnhiddenContext`](classes/GeneralForumTopicUnhiddenContext.md) | contexts/index.d.ts:6776 |
|  `gift` | *typeof* [`GiftContext`](classes/GiftContext.md) | contexts/index.d.ts:6782 |
|  `gift_upgrade_sent` | *typeof* [`GiftUpgradeSentContext`](classes/GiftUpgradeSentContext.md) | contexts/index.d.ts:6783 |
|  `giveaway_completed` | *typeof* [`GiveawayCompletedContext`](classes/GiveawayCompletedContext.md) | contexts/index.d.ts:6800 |
|  `giveaway_created` | *typeof* [`GiveawayCreatedContext`](classes/GiveawayCreatedContext.md) | contexts/index.d.ts:6799 |
|  `giveaway_winners` | *typeof* [`GiveawayWinnersContext`](classes/GiveawayWinnersContext.md) | contexts/index.d.ts:6801 |
|  `group_chat_created` | *typeof* [`GroupChatCreatedContext`](classes/GroupChatCreatedContext.md) | contexts/index.d.ts:6735 |
|  `inline_query` | *typeof* [`InlineQueryContext`](classes/InlineQueryContext.md) | contexts/index.d.ts:6736 |
|  `invoice` | *typeof* [`InvoiceContext`](classes/InvoiceContext.md) | contexts/index.d.ts:6737 |
|  `left_chat_member` | *typeof* [`LeftChatMemberContext`](classes/LeftChatMemberContext.md) | contexts/index.d.ts:6738 |
|  `location` | *typeof* [`LocationContext`](classes/LocationContext.md) | contexts/index.d.ts:6739 |
|  `message` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6741 |
|  `message_auto_delete_timer_changed` | *typeof* [`MessageAutoDeleteTimerChangedContext`](classes/MessageAutoDeleteTimerChangedContext.md) | contexts/index.d.ts:6740 |
|  `message_reaction` | *typeof* [`MessageReactionContext`](classes/MessageReactionContext.md) | contexts/index.d.ts:6795 |
|  `message_reaction_count` | *typeof* [`MessageReactionCountContext`](classes/MessageReactionCountContext.md) | contexts/index.d.ts:6796 |
|  `migrate_from_chat_id` | *typeof* [`MigrateFromChatIdContext`](classes/MigrateFromChatIdContext.md) | contexts/index.d.ts:6749 |
|  `migrate_to_chat_id` | *typeof* [`MigrateToChatIdContext`](classes/MigrateToChatIdContext.md) | contexts/index.d.ts:6750 |
|  `my_chat_member` | *typeof* [`ChatMemberContext`](classes/ChatMemberContext.md) | contexts/index.d.ts:6732 |
|  `new_chat_members` | *typeof* [`NewChatMembersContext`](classes/NewChatMembersContext.md) | contexts/index.d.ts:6751 |
|  `new_chat_photo` | *typeof* [`NewChatPhotoContext`](classes/NewChatPhotoContext.md) | contexts/index.d.ts:6752 |
|  `new_chat_title` | *typeof* [`NewChatTitleContext`](classes/NewChatTitleContext.md) | contexts/index.d.ts:6753 |
|  `paid_message_price_changed` | *typeof* [`PaidMessagePriceChangedContext`](classes/PaidMessagePriceChangedContext.md) | contexts/index.d.ts:6787 |
|  `passport_data` | *typeof* [`PassportDataContext`](classes/PassportDataContext.md) | contexts/index.d.ts:6754 |
|  `pinned_message` | *typeof* [`PinnedMessageContext`](classes/PinnedMessageContext.md) | contexts/index.d.ts:6755 |
|  `poll` | *typeof* [`PollContext`](classes/PollContext.md) | contexts/index.d.ts:6757 |
|  `poll_answer` | *typeof* [`PollAnswerContext`](classes/PollAnswerContext.md) | contexts/index.d.ts:6756 |
|  `pre_checkout_query` | *typeof* [`PreCheckoutQueryContext`](classes/PreCheckoutQueryContext.md) | contexts/index.d.ts:6758 |
|  `proximity_alert_triggered` | *typeof* [`ProximityAlertTriggeredContext`](classes/ProximityAlertTriggeredContext.md) | contexts/index.d.ts:6759 |
|  `purchased_paid_media` | *typeof* [`PaidMediaPurchasedContext`](classes/PaidMediaPurchasedContext.md) | contexts/index.d.ts:6794 |
|  `refunded_payment` | *typeof* [`RefundedPaymentContext`](classes/RefundedPaymentContext.md) | contexts/index.d.ts:6779 |
|  `removed_chat_boost` | *typeof* [`RemovedChatBoostContext`](classes/RemovedChatBoostContext.md) | contexts/index.d.ts:6798 |
|  `service_message` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6793 |
|  `shipping_query` | *typeof* [`ShippingQueryContext`](classes/ShippingQueryContext.md) | contexts/index.d.ts:6777 |
|  `successful_payment` | *typeof* [`SuccessfulPaymentContext`](classes/SuccessfulPaymentContext.md) | contexts/index.d.ts:6778 |
|  `suggested_post_approval_failed` | *typeof* [`SuggestedPostApprovalFailedContext`](classes/SuggestedPostApprovalFailedContext.md) | contexts/index.d.ts:6767 |
|  `suggested_post_approved` | *typeof* [`SuggestedPostApprovedContext`](classes/SuggestedPostApprovedContext.md) | contexts/index.d.ts:6766 |
|  `suggested_post_declined` | *typeof* [`SuggestedPostDeclinedContext`](classes/SuggestedPostDeclinedContext.md) | contexts/index.d.ts:6768 |
|  `suggested_post_paid` | *typeof* [`SuggestedPostPaidContext`](classes/SuggestedPostPaidContext.md) | contexts/index.d.ts:6769 |
|  `suggested_post_refunded` | *typeof* [`SuggestedPostRefundedContext`](classes/SuggestedPostRefundedContext.md) | contexts/index.d.ts:6770 |
|  `unique_gift` | *typeof* [`UniqueGiftContext`](classes/UniqueGiftContext.md) | contexts/index.d.ts:6784 |
|  `users_shared` | *typeof* [`UsersSharedContext`](classes/UsersSharedContext.md) | contexts/index.d.ts:6780 |
|  `video_chat_ended` | *typeof* [`VideoChatEndedContext`](classes/VideoChatEndedContext.md) | contexts/index.d.ts:6788 |
|  `video_chat_participants_invited` | *typeof* [`VideoChatParticipantsInvitedContext`](classes/VideoChatParticipantsInvitedContext.md) | contexts/index.d.ts:6789 |
|  `video_chat_scheduled` | *typeof* [`VideoChatScheduledContext`](classes/VideoChatScheduledContext.md) | contexts/index.d.ts:6790 |
|  `video_chat_started` | *typeof* [`VideoChatStartedContext`](classes/VideoChatStartedContext.md) | contexts/index.d.ts:6791 |
|  `web_app_data` | *typeof* [`WebAppDataContext`](classes/WebAppDataContext.md) | contexts/index.d.ts:6792 |
|  `write_access_allowed` | *typeof* [`WriteAccessAllowedContext`](classes/WriteAccessAllowedContext.md) | contexts/index.d.ts:6760 |

#### Example

```typescript
contextMappings["message"] is MessageContext
```

***

### EVENTS

> `const` **EVENTS**: \[keyof [`Message`](classes/Message.md), [`MessageEventName`](type-aliases/MessageEventName.md)]\[]

Defined in: contexts/index.d.ts:6711

Array of EVENTS

***

### filterPayload()

> `const` **filterPayload**: (`payload`) => `Record`<`string`, `unknown`>

Defined in: contexts/index.d.ts:6705

Helper for filter objects

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `Record`<`string`, `any`> |

#### Returns

`Record`<`string`, `unknown`>

***

### isParsable()

> `const` **isParsable**: (`source`) => `boolean`

Defined in: contexts/index.d.ts:6707

Guard to check is string can be parsed via JSON.parse

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `source` | `string` |

#### Returns

`boolean`

***

### isPlainObject()

> `const` **isPlainObject**: (`object`) => `object is Record<string, any>`

Defined in: contexts/index.d.ts:6703

Guard to check is it play object

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `object` | `object` |

#### Returns

`object is Record<string, any>`

***

### paidMediaMap

> `const` **paidMediaMap**: `object`

Defined in: contexts/index.d.ts:4354

This object describes paid media. Currently, it can be one of

* [PaidMediaPreview](https://core.telegram.org/bots/api/#paidmediapreview)
* [PaidMediaPhoto](https://core.telegram.org/bots/api/#paidmediaphoto)
* [PaidMediaVideo](https://core.telegram.org/bots/api/#paidmediavideo)

[Documentation](https://core.telegram.org/bots/api/#paidmedia)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
|  `photo` | *typeof* [`PaidMediaPhoto`](classes/PaidMediaPhoto.md) | contexts/index.d.ts:4357 |
|  `preview` | *typeof* [`PaidMediaPreview`](classes/PaidMediaPreview.md) | contexts/index.d.ts:4355 |
|  `video` | *typeof* [`PaidMediaVideo`](classes/PaidMediaVideo.md) | contexts/index.d.ts:4356 |

***

### SERVICE\_MESSAGE\_EVENTS

> `const` **SERVICE\_MESSAGE\_EVENTS**: [`MessageEventName`](type-aliases/MessageEventName.md)\[]

Defined in: contexts/index.d.ts:6709

Array of SERVICE\_MESSAGE\_EVENTS

## Functions

### memoizeGetters()

> **memoizeGetters**<`T`>(`cls`, `fields`): `void`

Defined in: contexts/index.d.ts:6699

Helper for getters memoization

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `cls` | (...`args`) => `T` |
| `fields` | keyof `T`\[] |

#### Returns

`void`

***

### sleep()

> **sleep**(`ms`): `Promise`<`unknown`>

Defined in: contexts/index.d.ts:5204

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ms` | `number` |

#### Returns

`Promise`<`unknown`>

---

---
url: 'https://gramio.dev/api/files.md'
---
[GramIO API Reference](../../../index.md) / @gramio/files/dist

# @gramio/files/dist

## Classes

| Class | Description |
| ------ | ------ |
| [MediaInput](classes/MediaInput.md) | Class-helper with static methods that represents the content of a media message to be sent. |
| [MediaUpload](classes/MediaUpload.md) | Class-helper with static methods for file uploading. |

## Variables

### MEDIA\_METHODS

> `const` **MEDIA\_METHODS**: `MethodsWithMediaUpload`

Defined in: files/index.d.ts:41

A set of methods with the function of checking whether a File has been passed in the parameters

#### Codegenerated

## Functions

### convertJsonToFormData()

> **convertJsonToFormData**<`T`>(`method`, `params`): `Promise`<`FormData`>

Defined in: files/index.d.ts:12

Helper to convert JSON to FormData that can accept Telegram Bot API.
if File is not top-level property it will be `“attach://<file_attach_name>”`

[Documentation](https://core.telegram.org/bots/api#inputfile)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* keyof [`APIMethods`](../../../gramio/interfaces/APIMethods.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `method` | `T` |
| `params` | `NonNullable`<[`APIMethodParams`](../../../gramio/type-aliases/APIMethodParams.md)<`T`>> |

#### Returns

`Promise`<`FormData`>

***

### convertStreamToBuffer()

> **convertStreamToBuffer**(`stream`): `Promise`<`Buffer`<`ArrayBufferLike`>>

Defined in: files/index.d.ts:21

Helper for convert Readable stream to buffer

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Readable` |

#### Returns

`Promise`<`Buffer`<`ArrayBufferLike`>>

***

### extractFilesToFormData()

> **extractFilesToFormData**<`T`>(`method`, `params`): `Promise`<\[`FormData`, `NonNullable`<[`APIMethodParams`](../../../gramio/type-aliases/APIMethodParams.md)<`T`>>]>

Defined in: files/index.d.ts:19

Helper to extract files from params and convert them to FormData. (Similar to [convertJsonToFormData](#convertjsontoformdata))
if File is not top-level property it will be `“attach://<file_attach_name>”`

[Documentation](https://core.telegram.org/bots/api#inputfile)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* keyof [`APIMethods`](../../../gramio/interfaces/APIMethods.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `method` | `T` |
| `params` | `NonNullable`<[`APIMethodParams`](../../../gramio/type-aliases/APIMethodParams.md)<`T`>> |

#### Returns

`Promise`<\[`FormData`, `NonNullable`<[`APIMethodParams`](../../../gramio/type-aliases/APIMethodParams.md)<`T`>>]>

***

### isBlob()

> **isBlob**(`blob?`): `boolean`

Defined in: files/index.d.ts:35

Guard to check is it Blob or Promise

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `blob?` | `string` | `object` | `Blob` |

#### Returns

`boolean`

***

### isMediaUpload()

> **isMediaUpload**<`T`>(`method`, `params`): `boolean`

Defined in: files/index.d.ts:5

Guard to check is method used for File Uploading

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* keyof [`APIMethods`](../../../gramio/interfaces/APIMethods.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `method` | `T` |
| `params` | `NonNullable`<[`APIMethodParams`](../../../gramio/type-aliases/APIMethodParams.md)<`T`>> |

#### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/format.md'
---
[GramIO API Reference](../../../index.md) / @gramio/format/dist

# @gramio/format/dist

## Variables

### blockquote()

> `const` **blockquote**: {(`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md); (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md); }

Defined in: format/index.d.ts:103

Format text as blockquote. Cannot be nested.

#### Call Signature

> (`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Call Signature

> (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `strings` | `TemplateStringsArray` |
| ...`values` | [`Stringable`](../../../gramio/type-aliases/Stringable.md)\[] |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
blockquote`test`
format`test ${blockquote(bold("GramIO"))}`
format`Format text as ${blockquote`blockquote`}`;
```

![blockquote](https://gramio.dev/formatting/blockquote.png)

***

### bold()

> `const` **bold**: {(`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md); (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md); }

Defined in: format/index.d.ts:33

Format text as **bold**. Cannot be combined with `code` and `pre`.

#### Call Signature

> (`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Call Signature

> (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `strings` | `TemplateStringsArray` |
| ...`values` | [`Stringable`](../../../gramio/type-aliases/Stringable.md)\[] |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
bold`test`
format`test ${bold(italic("GramIO"))}`
format`Format text as ${bold`bold`}`;
```

![bold](https://gramio.dev/formatting/bold.png)

***

### code()

> `const` **code**: {(`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md); (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md); }

Defined in: format/index.d.ts:131

Format text as `code`. Cannot be combined with any other format.

#### Call Signature

> (`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Call Signature

> (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `strings` | `TemplateStringsArray` |
| ...`values` | [`Stringable`](../../../gramio/type-aliases/Stringable.md)\[] |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
code`test`
format`test ${code("copy it")}`
format`Format text as ${code`code`}`;
```

![code](https://gramio.dev/formatting/code.png)

***

### customEmoji()

> `const` **customEmoji**: (`str`, `custom_emoji_id`) => [`FormattableString`](../../../gramio/classes/FormattableString.md)

Defined in: format/index.d.ts:182

Insert custom emoji by their id.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) | `null` | `undefined` |
| `custom_emoji_id` | `string` |

#### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
customEmoji("⚔️", "5222106016283378623")
format`test ${customEmoji("⚔️", "5222106016283378623")}`
```

**NOTE**: Custom emoji entities can only be used by bots that purchased additional usernames on [Fragment](https://fragment.com/).
![customEmoji](https://gramio.dev/formatting/custom_emoji.png)

***

### dateTime()

> `const` **dateTime**: (`str`, `unix_time`, `date_time_format?`) => [`FormattableString`](../../../gramio/classes/FormattableString.md)

Defined in: format/index.d.ts:212

Format text as a date/time entity with a Unix timestamp.
Telegram renders it in the user's locale and timezone.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) | `null` | `undefined` | The display text (shown as-is when `date_time_format` is empty) |
| `unix_time` | `number` | Unix timestamp associated with the entity |
| `date_time_format?` | `string` | Optional format string matching `r|w?[dD]?[tT]?`: - `""` — display text as-is; user can still see the date in their local format - `"r"` — relative time (e.g. "in 3 hours"). Cannot be combined with other chars. - `"w"` — day of week in user's language - `"d"` — short date (e.g. "17.03.22") - `"D"` — long date (e.g. "March 17, 2022") - `"t"` — short time (e.g. "22:45") - `"T"` — long time (e.g. "22:45:00") - Combinations: `"wD"`, `"dt"`, `"wDT"`, `"Dt"`, etc. |

#### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
dateTime("soon", 1740787200, "r")           // relative: "in 2 days"
dateTime("17.03.22", 1740787200, "d")        // short date
dateTime("March 17", 1740787200, "D")        // long date
dateTime("22:45", 1740787200, "t")           // short time
dateTime("22:45:00", 1740787200, "T")        // long time
dateTime("Thu, March 17", 1740787200, "wD")  // weekday + long date
dateTime("March 17, 22:45", 1740787200, "Dt") // long date + short time
format`Event starts ${dateTime("March 17 at 22:45", 1740787200, "DT")}`
```

![dateTime](https://gramio.dev/formatting/date_time.png)

***

### expandableBlockquote()

> `const` **expandableBlockquote**: {(`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md); (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md); }

Defined in: format/index.d.ts:117

Format text as expandable blockquote. Cannot be nested.

#### Call Signature

> (`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Call Signature

> (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `strings` | `TemplateStringsArray` |
| ...`values` | [`Stringable`](../../../gramio/type-aliases/Stringable.md)\[] |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
blockquote`test`
format`test ${expandableBlockquote(bold("GramIO"))}`
format`Format text as ${expandableBlockquote`blockquote`}`;
```

![blockquote](https://gramio.dev/formatting/expandable_blockquote.png)

***

### FormattableMap

> `const` **FormattableMap**: `FormattableMethods`

Defined in: format/index.d.ts:14

A set of methods that decompose the [FormattableString](../../../gramio/classes/FormattableString.md) into a string and
an array of [entities](https://core.telegram.org/bots/api#messageentity) for further sending to the Telegram Bot API

#### Codegenerated

***

### italic()

> `const` **italic**: {(`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md); (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md); }

Defined in: format/index.d.ts:47

Format text as *italic*. Cannot be combined with `code` and `pre`.

#### Call Signature

> (`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Call Signature

> (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `strings` | `TemplateStringsArray` |
| ...`values` | [`Stringable`](../../../gramio/type-aliases/Stringable.md)\[] |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
italic`test`
format`test ${italic(bold("GramIO"))}`
format`Format text as ${italic`italic`}`;
```

![italic](https://gramio.dev/formatting/italic.png)

***

### link()

> `const` **link**: (`str`, `url`) => [`FormattableString`](../../../gramio/classes/FormattableString.md)

Defined in: format/index.d.ts:161

Format text as [link](https://github.com/gramiojs/gramio). Cannot be combined with `code` and `pre`.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) | `null` | `undefined` |
| `url` | `string` |

#### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
link("test", "https://...")
format`test ${bold(link("GramIO", "https://github.com/gramiojs/gramio"))}`
format`Format text as ${link("link", "https://github.com/gramiojs/gramio")}`;
```

![link](https://gramio.dev/formatting/link.png)

***

### mention()

> `const` **mention**: (`str`, `user`) => [`FormattableString`](../../../gramio/classes/FormattableString.md)

Defined in: format/index.d.ts:171

Format text as mention. Cannot be combined with `code` and `pre`.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) | `null` | `undefined` |
| `user` | [`TelegramUser`](../../../gramio/interfaces/TelegramUser.md) |

#### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
mention("friend", { id: 228, is_bot: false, first_name: "GramIO"})
format`test ${mention("friend", { id: 228, is_bot: false, first_name: "GramIO"})}`
```

![mention](https://gramio.dev/formatting/mention.png)

***

### pre()

> `const` **pre**: (`str`, `language?`) => [`FormattableString`](../../../gramio/classes/FormattableString.md)

Defined in: format/index.d.ts:150

Format text as `pre`. Cannot be combined with any other format.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) | `null` | `undefined` |
| `language?` | `string` |

#### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
pre`test`
format`test ${pre(`console.log("GramIO")`, "js")}`
```

pre with language result is

```js
console.log("GramIO")
```

[Supported languages](https://github.com/TelegramMessenger/libprisma#supported-languages)

![pre](https://gramio.dev/formatting/pre.png)

***

### spoiler()

> `const` **spoiler**: {(`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md); (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md); }

Defined in: format/index.d.ts:89

Format text as spoiler. Cannot be combined with `code` and `pre`.

#### Call Signature

> (`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Call Signature

> (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `strings` | `TemplateStringsArray` |
| ...`values` | [`Stringable`](../../../gramio/type-aliases/Stringable.md)\[] |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
spoiler`test`
format`test ${spoiler(bold("GramIO"))}`
format`Format text as ${spoiler`spoiler`}`;
```

![spoiler](https://gramio.dev/formatting/spoiler.png)

***

### strikethrough()

> `const` **strikethrough**: {(`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md); (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md); }

Defined in: format/index.d.ts:75

Format text as ~~strikethrough~~. Cannot be combined with `code` and `pre`.

#### Call Signature

> (`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Call Signature

> (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `strings` | `TemplateStringsArray` |
| ...`values` | [`Stringable`](../../../gramio/type-aliases/Stringable.md)\[] |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
strikethrough`test`
format`test ${strikethrough(bold("GramIO"))}`
format`Format text as ${strikethrough`strikethrough`}`;
```

![](https://gramio.dev/formatting/strikethrough.png)

***

### underline()

> `const` **underline**: {(`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md); (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md); }

Defined in: format/index.d.ts:61

Format text as underline. Cannot be combined with `code` and `pre`.

#### Call Signature

> (`str`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Call Signature

> (`strings`, ...`values`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `strings` | `TemplateStringsArray` |
| ...`values` | [`Stringable`](../../../gramio/type-aliases/Stringable.md)\[] |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
underline`test`
format`test ${underline(bold("GramIO"))}`
format`Format text as ${underline`underline`}`;
```

![underline](https://gramio.dev/formatting/underline.png)

## Functions

### format()

> **format**(`stringParts`, ...`strings`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

Defined in: format/index.d.ts:249

[Template literal](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
that helps construct message [entities](https://core.telegram.org/bots/api#messageentity) for text formatting.

[Documentation](https://gramio.dev/formatting/)

Use if you want to strip all of the indentation from the beginning of each line.

**NOTE**: for format with **arrays** use it with [join](#join) helper -

```ts
format`${join(["test", "other"], (x) => format`${bold(x)}`, "\n")}`
```

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stringParts` | `TemplateStringsArray` |
| ...`strings` | [`Stringable`](../../../gramio/type-aliases/Stringable.md)\[] |

#### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
bot.api.sendMessage({
     chat_id: 12321,
     text: format`${bold`Hi!`}
         Can ${italic(`you`)} help ${spoiler`me`}?
             Can you give me a ${link("star", "https://github.com/gramiojs/gramio")}?`
})
```

![format](https://gramio.dev/formatting/format.png)

***

### formatSaveIndents()

> **formatSaveIndents**(`stringParts`, ...`strings`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

Defined in: format/index.d.ts:275

[Template literal](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
that helps construct message [entities](https://core.telegram.org/bots/api#messageentity) for text formatting.

```
[Documentation](https://gramio.dev/formatting/)
```

Use if you want to save all of the indentation.

**NOTE**: for format with **arrays** use it with [join](#join) helper -

```ts
format`${join(["test", "other"], (x) => format`${bold(x)}`, "\n")}`
```

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stringParts` | `TemplateStringsArray` |
| ...`strings` | [`Stringable`](../../../gramio/type-aliases/Stringable.md)\[] |

#### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

#### Example

```ts
bot.api.sendMessage({
     chat_id: 12321,
     text: format`${bold`Hi!`}
         Can ${italic(`you`)} help ${spoiler`me`}?
             Can you give me a ${link("star", "https://github.com/gramiojs/gramio")}?`
})
```

![formatSaveIndents](https://gramio.dev/formatting/format-save-indents.png)

***

### join()

#### Call Signature

> **join**(`array`, `separator?`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

Defined in: format/index.d.ts:222

Helper for great work with formattable arrays. (\[].join break styling)
Separator by default is `, `

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `array` | (`false` | [`Stringable`](../../../gramio/type-aliases/Stringable.md))\[] |
| `separator?` | `string` |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Example

```ts
join([format`hello`, format`world`], "\n")
format`${join(["test", "other"], (x) => format`${bold(x)}`, "\n")}`
```

#### Call Signature

> **join**<`T`>(`array`, `iterator`, `separator?`): [`FormattableString`](../../../gramio/classes/FormattableString.md)

Defined in: format/index.d.ts:223

Helper for great work with formattable arrays. (\[].join break styling)
Separator by default is `, `

##### Type Parameters

| Type Parameter |
| ------ |
| `T` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `array` | `T`\[] |
| `iterator` | (`item`, `index`) => `false` | [`Stringable`](../../../gramio/type-aliases/Stringable.md) |
| `separator?` | `string` |

##### Returns

[`FormattableString`](../../../gramio/classes/FormattableString.md)

##### Example

```ts
join([format`hello`, format`world`], "\n")
format`${join(["test", "other"], (x) => format`${bold(x)}`, "\n")}`
```

## References

### FormattableString

Re-exports [FormattableString](../../../gramio/classes/FormattableString.md)

***

### getFormattable

Re-exports [getFormattable](../../../gramio/index.md#getformattable)

***

### Stringable

Re-exports [Stringable](../../../gramio/type-aliases/Stringable.md)

---

---
url: 'https://gramio.dev/api/i18n.md'
---
[GramIO API Reference](../../../index.md) / @gramio/i18n/dist

# @gramio/i18n/dist

## Interfaces

| Interface | Description |
| ------ | ------ |
| [I18nOptions](interfaces/I18nOptions.md) | - |
| [LanguageMap](interfaces/LanguageMap.md) | - |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [ExtractArgsParams](type-aliases/ExtractArgsParams.md) | - |
| [ExtractItemValue](type-aliases/ExtractItemValue.md) | - |
| [ExtractLanguages](type-aliases/ExtractLanguages.md) | - |
| [GetI18nKeys](type-aliases/GetI18nKeys.md) | - |
| [GetI18nParams](type-aliases/GetI18nParams.md) | - |
| [GetValueNested](type-aliases/GetValueNested.md) | - |
| [LanguagesMap](type-aliases/LanguagesMap.md) | - |
| [LocaleArgs](type-aliases/LocaleArgs.md) | - |
| [LocaleItem](type-aliases/LocaleItem.md) | - |
| [LocaleValue](type-aliases/LocaleValue.md) | - |
| [NestedKeysDelimited](type-aliases/NestedKeysDelimited.md) | - |
| [ShouldFollowLanguage](type-aliases/ShouldFollowLanguage.md) | - |
| [ShouldFollowLanguageStrict](type-aliases/ShouldFollowLanguageStrict.md) | - |
| [SoftString](type-aliases/SoftString.md) | - |

## Functions

### defineI18n()

> **defineI18n**<`Languages`, `PrimaryLanguage`>(`__namedParameters`): `object`

Defined in: i18n/index.d.ts:41

#### Type Parameters

| Type Parameter |
| ------ |
| `Languages` *extends* [`LanguagesMap`](type-aliases/LanguagesMap.md) |
| `PrimaryLanguage` *extends* `string` | `number` | `symbol` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | [`I18nOptions`](interfaces/I18nOptions.md)<`Languages`, `PrimaryLanguage`> |

#### Returns

`object`

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `_` | `object` | i18n/index.d.ts:46 |
| `_.languages` | `Languages` | i18n/index.d.ts:47 |
| `_.primaryLanguage` | `PrimaryLanguage` | i18n/index.d.ts:48 |
| `buildT()` | <`Language`>(`language?`) => <`Key`, `Item`, `FallbackItem`>(`key`, ...`args`) => [`ExtractItemValue`](type-aliases/ExtractItemValue.md)<`Item`, `FallbackItem`> | i18n/index.d.ts:45 |
| `languages` | keyof `Languages`\[] | i18n/index.d.ts:43 |
| `primaryLanguage` | `PrimaryLanguage` | i18n/index.d.ts:44 |
| `t()` | <`Language`, `Key`, `Item`, `FallbackItem`>(`language`, `key`, ...`args`) => [`ExtractItemValue`](type-aliases/ExtractItemValue.md)<`Item`, `FallbackItem`> | i18n/index.d.ts:42 |

***

### pluralizeEnglish()

> **pluralizeEnglish**<`T`>(`n`, `one`, `many`): `T`

Defined in: i18n/index.d.ts:37

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `n` | `number` |
| `one` | `T` |
| `many` | `T` |

#### Returns

`T`

***

### pluralizeRussian()

> **pluralizeRussian**<`T`>(`count`, `one`, `few`, `many`): `T`

Defined in: i18n/index.d.ts:39

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `count` | `number` |
| `one` | `T` |
| `few` | `T` |
| `many` | `T` |

#### Returns

`T`

---

---
url: 'https://gramio.dev/api/init-data.md'
---
[GramIO API Reference](../../../index.md) / @gramio/init-data/dist

# @gramio/init-data/dist

## Interfaces

| Interface | Description |
| ------ | ------ |
| [WebAppChat](interfaces/WebAppChat.md) | This object represents a chat. |
| [WebAppInitData](interfaces/WebAppInitData.md) | This object contains data that is transferred to the Mini App when it is opened. It is empty if the Mini App was launched from a [keyboard button](https://core.telegram.org/bots/webapps#keyboard-button-mini-apps) or from [inline mode](https://core.telegram.org/bots/webapps#inline-mode-mini-apps). |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [MakeOptional](type-aliases/MakeOptional.md) | - |
| [Optional](type-aliases/Optional.md) | - |
| [WebAppChatType](type-aliases/WebAppChatType.md) | Known type of chat. |
| [WebAppUser](type-aliases/WebAppUser.md) | This object contains the data of the Mini App user. |

## Variables

### sha256Hash()

> `const` **sha256Hash**: (`hmacKey`, `input`, `encoding?`) => `string`

Defined in: init-data/index.d.ts:142

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `hmacKey` | `string` | `Buffer` |
| `input` | `string` |
| `encoding?` | `BinaryToTextEncoding` |

#### Returns

`string`

## Functions

### getBotTokenSecretKey()

> **getBotTokenSecretKey**(`botToken`): `Buffer`<`ArrayBufferLike`>

Defined in: init-data/index.d.ts:143

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `botToken` | `string` |

#### Returns

`Buffer`<`ArrayBufferLike`>

***

### parseInitData()

> **parseInitData**(`query`): [`WebAppInitData`](interfaces/WebAppInitData.md)

Defined in: init-data/index.d.ts:146

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `string` |

#### Returns

[`WebAppInitData`](interfaces/WebAppInitData.md)

***

### parseJSON()

> **parseJSON**<`T`>(`value`): `T`

Defined in: init-data/index.d.ts:141

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `string` |

#### Returns

`T`

***

### serializeInitData()

> **serializeInitData**(`data`): `URLSearchParams`

Defined in: init-data/index.d.ts:144

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `data` | [`MakeOptional`](type-aliases/MakeOptional.md)<[`WebAppInitData`](interfaces/WebAppInitData.md), `"hash"` | `"auth_date"`> |

#### Returns

`URLSearchParams`

***

### signInitData()

#### Call Signature

> **signInitData**(`initData`, `secretKeyOrToken`): `string`

Defined in: init-data/index.d.ts:150

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `initData` | `string` |
| `secretKeyOrToken` | `string` | `Buffer`<`ArrayBufferLike`> |

##### Returns

`string`

#### Call Signature

> **signInitData**(`initData`, `secretKeyOrToken`): `string`

Defined in: init-data/index.d.ts:151

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `initData` | [`MakeOptional`](type-aliases/MakeOptional.md)<[`WebAppInitData`](interfaces/WebAppInitData.md), `"hash"` | `"auth_date"`> |
| `secretKeyOrToken` | `string` | `Buffer`<`ArrayBufferLike`> |

##### Returns

`string`

***

### validateAndParseInitData()

> **validateAndParseInitData**(`query`, `token`): `false` | [`WebAppInitData`](interfaces/WebAppInitData.md)

Defined in: init-data/index.d.ts:148

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `string` |
| `token` | `string` | `Buffer`<`ArrayBufferLike`> |

#### Returns

`false` | [`WebAppInitData`](interfaces/WebAppInitData.md)

***

### validateInitData()

> **validateInitData**(`webAppInitData`, `token`): `boolean`

Defined in: init-data/index.d.ts:147

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `webAppInitData` | `string` |
| `token` | `string` | `Buffer`<`ArrayBufferLike`> |

#### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/keyboards.md'
---
[GramIO API Reference](../../../index.md) / @gramio/keyboards/dist

# @gramio/keyboards/dist

## Classes

| Class | Description |
| ------ | ------ |
| [BaseKeyboardConstructor](classes/BaseKeyboardConstructor.md) | Base-class for construct keyboard with useful helpers |
| [ForceReplyKeyboard](classes/ForceReplyKeyboard.md) | **ForceReply** builder |
| [InlineKeyboard](classes/InlineKeyboard.md) | **InlineKeyboardMarkup** builder |
| [InlineQueryResult](classes/InlineQueryResult.md) | Result of InlineQuery builder. |
| [InputMessageContent](classes/InputMessageContent.md) | This object represents the content of a message to be sent as a result of an inline query. |
| [Keyboard](classes/Keyboard.md) | **ReplyKeyboardMarkup** builder |
| [RemoveKeyboard](classes/RemoveKeyboard.md) | **ReplyKeyboardRemove** builder |

## Interfaces

| Interface | Description |
| ------ | ------ |
| [ButtonOptions](interfaces/ButtonOptions.md) | - |
| [KeyboardFeatureFlags](interfaces/KeyboardFeatureFlags.md) | - |
| [KeyboardHelperColumns](interfaces/KeyboardHelperColumns.md) | - |
| [KeyboardHelperFilter](interfaces/KeyboardHelperFilter.md) | - |
| [KeyboardHelperPattern](interfaces/KeyboardHelperPattern.md) | - |
| [KeyboardHelperWrap](interfaces/KeyboardHelperWrap.md) | - |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [ButtonsIterator](type-aliases/ButtonsIterator.md) | - |
| [CreateButtonIterator](type-aliases/CreateButtonIterator.md) | - |
| [KeyboardHelpers](type-aliases/KeyboardHelpers.md) | - |

## Variables

### keyboardsFeatureFlagsMap

> `const` **keyboardsFeatureFlagsMap**: [`KeyboardFeatureFlags`](interfaces/KeyboardFeatureFlags.md)

Defined in: keyboards/index.d.ts:10

## Functions

### chunk()

> **chunk**<`T`>(`array`, `size`): `T`\[]\[]

Defined in: keyboards/index.d.ts:38

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `array` | `T`\[]\[] |
| `size` | `number` |

#### Returns

`T`\[]\[]

***

### customWrap()

> **customWrap**<`T`>(`array`, `fn`): `T`\[]\[]

Defined in: keyboards/index.d.ts:39

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `array` | `T`\[]\[] |
| `fn` | [`ButtonsIterator`](type-aliases/ButtonsIterator.md)<`T`> |

#### Returns

`T`\[]\[]

***

### filter()

> **filter**<`T`>(`array`, `fn`): `T`\[]\[]

Defined in: keyboards/index.d.ts:41

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `array` | `T`\[]\[] |
| `fn` | [`ButtonsIterator`](type-aliases/ButtonsIterator.md)<`T`> |

#### Returns

`T`\[]\[]

***

### pattern()

> **pattern**<`T`>(`array`, `pattern`): `T`\[]\[]

Defined in: keyboards/index.d.ts:40

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `array` | `T`\[]\[] |
| `pattern` | `number`\[] |

#### Returns

`T`\[]\[]

---

---
url: 'https://gramio.dev/api/prompt.md'
---
[GramIO API Reference](../../../index.md) / @gramio/prompt/dist

# @gramio/prompt/dist

## Interfaces

| Interface | Description |
| ------ | ------ |
| [PromptFunction](interfaces/PromptFunction.md) | Send message and wait answer |
| [PromptFunctionParams](interfaces/PromptFunctionParams.md) | Make some keys optional |
| [PromptOptions](interfaces/PromptOptions.md) | - |
| [PromptPluginTypes](interfaces/PromptPluginTypes.md) | - |
| [WaitFunction](interfaces/WaitFunction.md) | Wait for the next event from the user |
| [WaitWithActionFunction](interfaces/WaitWithActionFunction.md) | - |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [EventsUnion](type-aliases/EventsUnion.md) | - |
| [MaybeArray](type-aliases/MaybeArray.md) | - |
| [OnValidateErrorFunction](type-aliases/OnValidateErrorFunction.md) | - |
| [PromptAnswer](type-aliases/PromptAnswer.md) | - |
| [PromptsType](type-aliases/PromptsType.md) | - |
| [Stringable](type-aliases/Stringable.md) | - |
| [TimeoutStrategy](type-aliases/TimeoutStrategy.md) | - |
| [TransformFunction](type-aliases/TransformFunction.md) | - |
| [ValidateFunction](type-aliases/ValidateFunction.md) | - |

## Functions

### prompt()

> **prompt**<`GlobalData`>(`options?`): [`Plugin`](../../../gramio/classes/Plugin.md)<{ `prompt-cancel`: `PromptCancelError`; }, [`DeriveDefinitions`](../../../gramio/type-aliases/DeriveDefinitions.md) & `object`>

Defined in: prompt/index.d.ts:153

Prompt plugin

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `GlobalData` | `never` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`PromptOptions`](interfaces/PromptOptions.md)<`GlobalData`> |

#### Returns

[`Plugin`](../../../gramio/classes/Plugin.md)<{ `prompt-cancel`: `PromptCancelError`; }, [`DeriveDefinitions`](../../../gramio/type-aliases/DeriveDefinitions.md) & `object`>

#### Example

```ts
import { Bot, format, bold } from "gramio";
import { prompt } from "@gramio/prompt";

const bot = new Bot(process.env.token!)
    .extend(prompt())
    .command("start", async (context) => {
        const answer = await context.prompt(
            "message",
            format`What's your ${bold`name`}?`
        );

        return context.send(`✨ Your name is ${answer.text}`);
    })
    .onStart(console.log);

bot.start();
```

---

---
url: 'https://gramio.dev/api/scenes.md'
---
[GramIO API Reference](../../../index.md) / @gramio/scenes/dist

# @gramio/scenes/dist

## Classes

| Class | Description |
| ------ | ------ |
| [Scene](classes/Scene.md) | - |

## Interfaces

| Interface | Description |
| ------ | ------ |
| [EnterExit](interfaces/EnterExit.md) | - |
| [InActiveSceneHandlerReturn](interfaces/InActiveSceneHandlerReturn.md) | - |
| [InUnknownScene](interfaces/InUnknownScene.md) | - |
| [ParentSceneFrame](interfaces/ParentSceneFrame.md) | - |
| [PossibleInUnknownScene](interfaces/PossibleInUnknownScene.md) | - |
| [ScenesOptions](interfaces/ScenesOptions.md) | - |
| [ScenesStorageData](interfaces/ScenesStorageData.md) | - |
| [SceneUpdateState](interfaces/SceneUpdateState.md) | - |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [AnyScene](type-aliases/AnyScene.md) | - |
| [Modify](type-aliases/Modify.md) | - |
| [SceneDerivesDefinitions](type-aliases/SceneDerivesDefinitions.md) | - |
| [SceneEnterHandler](type-aliases/SceneEnterHandler.md) | - |
| [ScenesStorage](type-aliases/ScenesStorage.md) | - |
| [SceneStepReturn](type-aliases/SceneStepReturn.md) | - |
| [StateTypesDefault](type-aliases/StateTypesDefault.md) | - |
| [StepHandler](type-aliases/StepHandler.md) | - |
| [UpdateData](type-aliases/UpdateData.md) | - |

## Functions

### scenes()

> **scenes**(`scenes`, `options?`): [`Plugin`](../../../gramio/classes/Plugin.md)<{ }, [`DeriveDefinitions`](../../../gramio/type-aliases/DeriveDefinitions.md) & `object`, { }>

Defined in: scenes/index.d.ts:789

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `scenes` | [`AnyScene`](type-aliases/AnyScene.md)\[] |
| `options?` | [`ScenesOptions`](interfaces/ScenesOptions.md) |

#### Returns

[`Plugin`](../../../gramio/classes/Plugin.md)<{ }, [`DeriveDefinitions`](../../../gramio/type-aliases/DeriveDefinitions.md) & `object`, { }>

***

### scenesDerives()

> **scenesDerives**<`WithCurrentScene`>(`scenesOrOptions`, `optionsRaw?`): [`EventComposer`](../../composer/dist/interfaces/EventComposer.md)<[`Context`](../../contexts/dist/classes/Context.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, { `boost_added`: [`BoostAddedContext`](../../contexts/dist/classes/BoostAddedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `business_connection`: [`BusinessConnectionContext`](../../contexts/dist/classes/BusinessConnectionContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `business_message`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `callback_query`: [`CallbackQueryContext`](../../contexts/dist/classes/CallbackQueryContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `channel_post`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_background_set`: [`ChatBackgroundSetContext`](../../contexts/dist/classes/ChatBackgroundSetContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_boost`: [`ChatBoostContext`](../../contexts/dist/classes/ChatBoostContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_join_request`: [`ChatJoinRequestContext`](../../contexts/dist/classes/ChatJoinRequestContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_member`: [`ChatMemberContext`](../../contexts/dist/classes/ChatMemberContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_owner_changed`: [`ChatOwnerChangedContext`](../../contexts/dist/classes/ChatOwnerChangedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_owner_left`: [`ChatOwnerLeftContext`](../../contexts/dist/classes/ChatOwnerLeftContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_shared`: [`ChatSharedContext`](../../contexts/dist/classes/ChatSharedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `checklist_tasks_added`: [`ChecklistTasksAddedContext`](../../contexts/dist/classes/ChecklistTasksAddedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `checklist_tasks_done`: [`ChecklistTasksDoneContext`](../../contexts/dist/classes/ChecklistTasksDoneContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chosen_inline_result`: [`ChosenInlineResultContext`](../../contexts/dist/classes/ChosenInlineResultContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `delete_chat_photo`: [`DeleteChatPhotoContext`](../../contexts/dist/classes/DeleteChatPhotoContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `deleted_business_messages`: [`BusinessMessagesDeletedContext`](../../contexts/dist/classes/BusinessMessagesDeletedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `direct_message_price_changed`: [`DirectMessagePriceChangedContext`](../../contexts/dist/classes/DirectMessagePriceChangedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `edited_business_message`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `edited_channel_post`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `edited_message`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `forum_topic_closed`: [`ForumTopicClosedContext`](../../contexts/dist/classes/ForumTopicClosedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `forum_topic_created`: [`ForumTopicCreatedContext`](../../contexts/dist/classes/ForumTopicCreatedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `forum_topic_edited`: [`ForumTopicEditedContext`](../../contexts/dist/classes/ForumTopicEditedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `forum_topic_reopened`: [`ForumTopicReopenedContext`](../../contexts/dist/classes/ForumTopicReopenedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `general_forum_topic_hidden`: [`GeneralForumTopicHiddenContext`](../../contexts/dist/classes/GeneralForumTopicHiddenContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `general_forum_topic_unhidden`: [`GeneralForumTopicUnhiddenContext`](../../contexts/dist/classes/GeneralForumTopicUnhiddenContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `gift`: [`GiftContext`](../../contexts/dist/classes/GiftContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `gift_upgrade_sent`: [`GiftUpgradeSentContext`](../../contexts/dist/classes/GiftUpgradeSentContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `giveaway_completed`: [`GiveawayCompletedContext`](../../contexts/dist/classes/GiveawayCompletedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `giveaway_created`: [`GiveawayCreatedContext`](../../contexts/dist/classes/GiveawayCreatedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `giveaway_winners`: [`GiveawayWinnersContext`](../../contexts/dist/classes/GiveawayWinnersContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `group_chat_created`: [`GroupChatCreatedContext`](../../contexts/dist/classes/GroupChatCreatedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `inline_query`: [`InlineQueryContext`](../../contexts/dist/classes/InlineQueryContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `invoice`: [`InvoiceContext`](../../contexts/dist/classes/InvoiceContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `left_chat_member`: [`LeftChatMemberContext`](../../contexts/dist/classes/LeftChatMemberContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `location`: [`LocationContext`](../../contexts/dist/classes/LocationContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `message`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `message_auto_delete_timer_changed`: [`MessageAutoDeleteTimerChangedContext`](../../contexts/dist/classes/MessageAutoDeleteTimerChangedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `message_reaction`: [`MessageReactionContext`](../../contexts/dist/classes/MessageReactionContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `message_reaction_count`: [`MessageReactionCountContext`](../../contexts/dist/classes/MessageReactionCountContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `migrate_from_chat_id`: [`MigrateFromChatIdContext`](../../contexts/dist/classes/MigrateFromChatIdContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `migrate_to_chat_id`: [`MigrateToChatIdContext`](../../contexts/dist/classes/MigrateToChatIdContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `my_chat_member`: [`ChatMemberContext`](../../contexts/dist/classes/ChatMemberContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `new_chat_members`: [`NewChatMembersContext`](../../contexts/dist/classes/NewChatMembersContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `new_chat_photo`: [`NewChatPhotoContext`](../../contexts/dist/classes/NewChatPhotoContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `new_chat_title`: [`NewChatTitleContext`](../../contexts/dist/classes/NewChatTitleContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `paid_message_price_changed`: [`PaidMessagePriceChangedContext`](../../contexts/dist/classes/PaidMessagePriceChangedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `passport_data`: [`PassportDataContext`](../../contexts/dist/classes/PassportDataContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `pinned_message`: [`PinnedMessageContext`](../../contexts/dist/classes/PinnedMessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `poll`: [`PollContext`](../../contexts/dist/classes/PollContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `poll_answer`: [`PollAnswerContext`](../../contexts/dist/classes/PollAnswerContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `pre_checkout_query`: [`PreCheckoutQueryContext`](../../contexts/dist/classes/PreCheckoutQueryContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `proximity_alert_triggered`: [`ProximityAlertTriggeredContext`](../../contexts/dist/classes/ProximityAlertTriggeredContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `purchased_paid_media`: [`PaidMediaPurchasedContext`](../../contexts/dist/classes/PaidMediaPurchasedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `refunded_payment`: [`RefundedPaymentContext`](../../contexts/dist/classes/RefundedPaymentContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `removed_chat_boost`: [`RemovedChatBoostContext`](../../contexts/dist/classes/RemovedChatBoostContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `service_message`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `shipping_query`: [`ShippingQueryContext`](../../contexts/dist/classes/ShippingQueryContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `successful_payment`: [`SuccessfulPaymentContext`](../../contexts/dist/classes/SuccessfulPaymentContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_approval_failed`: [`SuggestedPostApprovalFailedContext`](../../contexts/dist/classes/SuggestedPostApprovalFailedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_approved`: [`SuggestedPostApprovedContext`](../../contexts/dist/classes/SuggestedPostApprovedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_declined`: [`SuggestedPostDeclinedContext`](../../contexts/dist/classes/SuggestedPostDeclinedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_paid`: [`SuggestedPostPaidContext`](../../contexts/dist/classes/SuggestedPostPaidContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_refunded`: [`SuggestedPostRefundedContext`](../../contexts/dist/classes/SuggestedPostRefundedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `unique_gift`: [`UniqueGiftContext`](../../contexts/dist/classes/UniqueGiftContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `users_shared`: [`UsersSharedContext`](../../contexts/dist/classes/UsersSharedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `video_chat_ended`: [`VideoChatEndedContext`](../../contexts/dist/classes/VideoChatEndedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `video_chat_participants_invited`: [`VideoChatParticipantsInvitedContext`](../../contexts/dist/classes/VideoChatParticipantsInvitedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `video_chat_scheduled`: [`VideoChatScheduledContext`](../../contexts/dist/classes/VideoChatScheduledContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `video_chat_started`: [`VideoChatStartedContext`](../../contexts/dist/classes/VideoChatStartedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `web_app_data`: [`WebAppDataContext`](../../contexts/dist/classes/WebAppDataContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `write_access_allowed`: [`WriteAccessAllowedContext`](../../contexts/dist/classes/WriteAccessAllowedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; }, [`Context`](../../contexts/dist/classes/Context.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, [`Context`](../../contexts/dist/classes/Context.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, { }, { `callback_query`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `channel_post`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `chat_join_request`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `chat_shared`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `chosen_inline_result`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `delete_chat_photo`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `group_chat_created`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `inline_query`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `invoice`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `location`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `message`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `message_auto_delete_timer_changed`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `migrate_from_chat_id`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `migrate_to_chat_id`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `new_chat_members`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `new_chat_photo`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `new_chat_title`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `passport_data`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `pinned_message`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `pre_checkout_query`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `proximity_alert_triggered`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `shipping_query`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `successful_payment`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `users_shared`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `video_chat_ended`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `video_chat_participants_invited`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `video_chat_scheduled`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `video_chat_started`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `web_app_data`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; }, { `callbackQuery`: `TThis`; `chosenInlineResult`: `TThis`; `command`: `TThis`; `hears`: `TThis`; `inlineQuery`: `TThis`; `reaction`: `TThis`; `startParameter`: `TThis`; }, { }> & `object`

Defined in: scenes/index.d.ts:494

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `WithCurrentScene` *extends* `boolean` | `false` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `scenesOrOptions` | [`AnyScene`](type-aliases/AnyScene.md)\[] | `ScenesDerivesOptions`<`WithCurrentScene`> |
| `optionsRaw?` | `ScenesDerivesOptions`<`WithCurrentScene`> |

#### Returns

[`EventComposer`](../../composer/dist/interfaces/EventComposer.md)<[`Context`](../../contexts/dist/classes/Context.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, { `boost_added`: [`BoostAddedContext`](../../contexts/dist/classes/BoostAddedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `business_connection`: [`BusinessConnectionContext`](../../contexts/dist/classes/BusinessConnectionContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `business_message`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `callback_query`: [`CallbackQueryContext`](../../contexts/dist/classes/CallbackQueryContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `channel_post`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_background_set`: [`ChatBackgroundSetContext`](../../contexts/dist/classes/ChatBackgroundSetContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_boost`: [`ChatBoostContext`](../../contexts/dist/classes/ChatBoostContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_join_request`: [`ChatJoinRequestContext`](../../contexts/dist/classes/ChatJoinRequestContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_member`: [`ChatMemberContext`](../../contexts/dist/classes/ChatMemberContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_owner_changed`: [`ChatOwnerChangedContext`](../../contexts/dist/classes/ChatOwnerChangedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_owner_left`: [`ChatOwnerLeftContext`](../../contexts/dist/classes/ChatOwnerLeftContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chat_shared`: [`ChatSharedContext`](../../contexts/dist/classes/ChatSharedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `checklist_tasks_added`: [`ChecklistTasksAddedContext`](../../contexts/dist/classes/ChecklistTasksAddedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `checklist_tasks_done`: [`ChecklistTasksDoneContext`](../../contexts/dist/classes/ChecklistTasksDoneContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `chosen_inline_result`: [`ChosenInlineResultContext`](../../contexts/dist/classes/ChosenInlineResultContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `delete_chat_photo`: [`DeleteChatPhotoContext`](../../contexts/dist/classes/DeleteChatPhotoContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `deleted_business_messages`: [`BusinessMessagesDeletedContext`](../../contexts/dist/classes/BusinessMessagesDeletedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `direct_message_price_changed`: [`DirectMessagePriceChangedContext`](../../contexts/dist/classes/DirectMessagePriceChangedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `edited_business_message`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `edited_channel_post`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `edited_message`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `forum_topic_closed`: [`ForumTopicClosedContext`](../../contexts/dist/classes/ForumTopicClosedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `forum_topic_created`: [`ForumTopicCreatedContext`](../../contexts/dist/classes/ForumTopicCreatedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `forum_topic_edited`: [`ForumTopicEditedContext`](../../contexts/dist/classes/ForumTopicEditedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `forum_topic_reopened`: [`ForumTopicReopenedContext`](../../contexts/dist/classes/ForumTopicReopenedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `general_forum_topic_hidden`: [`GeneralForumTopicHiddenContext`](../../contexts/dist/classes/GeneralForumTopicHiddenContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `general_forum_topic_unhidden`: [`GeneralForumTopicUnhiddenContext`](../../contexts/dist/classes/GeneralForumTopicUnhiddenContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `gift`: [`GiftContext`](../../contexts/dist/classes/GiftContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `gift_upgrade_sent`: [`GiftUpgradeSentContext`](../../contexts/dist/classes/GiftUpgradeSentContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `giveaway_completed`: [`GiveawayCompletedContext`](../../contexts/dist/classes/GiveawayCompletedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `giveaway_created`: [`GiveawayCreatedContext`](../../contexts/dist/classes/GiveawayCreatedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `giveaway_winners`: [`GiveawayWinnersContext`](../../contexts/dist/classes/GiveawayWinnersContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `group_chat_created`: [`GroupChatCreatedContext`](../../contexts/dist/classes/GroupChatCreatedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `inline_query`: [`InlineQueryContext`](../../contexts/dist/classes/InlineQueryContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `invoice`: [`InvoiceContext`](../../contexts/dist/classes/InvoiceContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `left_chat_member`: [`LeftChatMemberContext`](../../contexts/dist/classes/LeftChatMemberContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `location`: [`LocationContext`](../../contexts/dist/classes/LocationContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `message`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `message_auto_delete_timer_changed`: [`MessageAutoDeleteTimerChangedContext`](../../contexts/dist/classes/MessageAutoDeleteTimerChangedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `message_reaction`: [`MessageReactionContext`](../../contexts/dist/classes/MessageReactionContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `message_reaction_count`: [`MessageReactionCountContext`](../../contexts/dist/classes/MessageReactionCountContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `migrate_from_chat_id`: [`MigrateFromChatIdContext`](../../contexts/dist/classes/MigrateFromChatIdContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `migrate_to_chat_id`: [`MigrateToChatIdContext`](../../contexts/dist/classes/MigrateToChatIdContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `my_chat_member`: [`ChatMemberContext`](../../contexts/dist/classes/ChatMemberContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `new_chat_members`: [`NewChatMembersContext`](../../contexts/dist/classes/NewChatMembersContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `new_chat_photo`: [`NewChatPhotoContext`](../../contexts/dist/classes/NewChatPhotoContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `new_chat_title`: [`NewChatTitleContext`](../../contexts/dist/classes/NewChatTitleContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `paid_message_price_changed`: [`PaidMessagePriceChangedContext`](../../contexts/dist/classes/PaidMessagePriceChangedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `passport_data`: [`PassportDataContext`](../../contexts/dist/classes/PassportDataContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `pinned_message`: [`PinnedMessageContext`](../../contexts/dist/classes/PinnedMessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `poll`: [`PollContext`](../../contexts/dist/classes/PollContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `poll_answer`: [`PollAnswerContext`](../../contexts/dist/classes/PollAnswerContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `pre_checkout_query`: [`PreCheckoutQueryContext`](../../contexts/dist/classes/PreCheckoutQueryContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `proximity_alert_triggered`: [`ProximityAlertTriggeredContext`](../../contexts/dist/classes/ProximityAlertTriggeredContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `purchased_paid_media`: [`PaidMediaPurchasedContext`](../../contexts/dist/classes/PaidMediaPurchasedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `refunded_payment`: [`RefundedPaymentContext`](../../contexts/dist/classes/RefundedPaymentContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `removed_chat_boost`: [`RemovedChatBoostContext`](../../contexts/dist/classes/RemovedChatBoostContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `service_message`: [`MessageContext`](../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `shipping_query`: [`ShippingQueryContext`](../../contexts/dist/classes/ShippingQueryContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `successful_payment`: [`SuccessfulPaymentContext`](../../contexts/dist/classes/SuccessfulPaymentContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_approval_failed`: [`SuggestedPostApprovalFailedContext`](../../contexts/dist/classes/SuggestedPostApprovalFailedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_approved`: [`SuggestedPostApprovedContext`](../../contexts/dist/classes/SuggestedPostApprovedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_declined`: [`SuggestedPostDeclinedContext`](../../contexts/dist/classes/SuggestedPostDeclinedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_paid`: [`SuggestedPostPaidContext`](../../contexts/dist/classes/SuggestedPostPaidContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_refunded`: [`SuggestedPostRefundedContext`](../../contexts/dist/classes/SuggestedPostRefundedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `unique_gift`: [`UniqueGiftContext`](../../contexts/dist/classes/UniqueGiftContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `users_shared`: [`UsersSharedContext`](../../contexts/dist/classes/UsersSharedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `video_chat_ended`: [`VideoChatEndedContext`](../../contexts/dist/classes/VideoChatEndedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `video_chat_participants_invited`: [`VideoChatParticipantsInvitedContext`](../../contexts/dist/classes/VideoChatParticipantsInvitedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `video_chat_scheduled`: [`VideoChatScheduledContext`](../../contexts/dist/classes/VideoChatScheduledContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `video_chat_started`: [`VideoChatStartedContext`](../../contexts/dist/classes/VideoChatStartedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `web_app_data`: [`WebAppDataContext`](../../contexts/dist/classes/WebAppDataContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; `write_access_allowed`: [`WriteAccessAllowedContext`](../../contexts/dist/classes/WriteAccessAllowedContext.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>; }, [`Context`](../../contexts/dist/classes/Context.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, [`Context`](../../contexts/dist/classes/Context.md)<[`AnyBot`](../../../gramio/type-aliases/AnyBot.md)>, { }, { `callback_query`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `channel_post`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `chat_join_request`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `chat_shared`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `chosen_inline_result`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `delete_chat_photo`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `group_chat_created`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `inline_query`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `invoice`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `location`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `message`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `message_auto_delete_timer_changed`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `migrate_from_chat_id`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `migrate_to_chat_id`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `new_chat_members`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `new_chat_photo`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `new_chat_title`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `passport_data`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `pinned_message`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `pre_checkout_query`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `proximity_alert_triggered`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `shipping_query`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `successful_payment`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `users_shared`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `video_chat_ended`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `video_chat_participants_invited`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `video_chat_scheduled`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `video_chat_started`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; `web_app_data`: { `scene`: `WithCurrentScene` *extends* `true` ? [`PossibleInUnknownScene`](interfaces/PossibleInUnknownScene.md)<`any`, `any`, `null`> : [`EnterExit`](interfaces/EnterExit.md); }; }, { `callbackQuery`: `TThis`; `chosenInlineResult`: `TThis`; `command`: `TThis`; `hears`: `TThis`; `inlineQuery`: `TThis`; `reaction`: `TThis`; `startParameter`: `TThis`; }, { }> & `object`

---

---
url: 'https://gramio.dev/ecosystem/schema-parser.md'
---

# @gramio/schema-parser

[![npm](https://img.shields.io/npm/v/@gramio/schema-parser?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/schema-parser)
[![JSR](https://jsr.io/badges/@gramio/schema-parser)](https://jsr.io/@gramio/schema-parser)

A TypeScript library that parses the [Telegram Bot API](https://core.telegram.org/bots/api) HTML documentation into a structured, type-annotated schema. It is used internally by [`@gramio/types`](/types) to generate all TypeScript type declarations — replacing the previous dependency on the Rust-based `tg-bot-api` crate.

> This is an **advanced / infrastructure package**. Regular bot developers don't need it. It's relevant if you're building type generators, linters, documentation tools, or anything that needs a machine-readable representation of the Telegram Bot API.

## Installation

::: pm-add @gramio/schema-parser
:::

## Basic Usage

```ts
import { parseSchema } from "@gramio/schema-parser";

const schema = await parseSchema(); // fetches https://core.telegram.org/bots/api

console.log(schema.methods.sendMessage);
// {
//   name: "sendMessage",
//   description: "...",
//   fields: [ ... ],
//   returns: { type: "reference", name: "Message" }
// }

console.log(schema.objects.Message);
// {
//   name: "Message",
//   description: "...",
//   fields: [ ... ]
// }
```

## Schema Structure

The parsed schema has two top-level maps:

```ts
interface BotAPISchema {
    methods: Record<string, Method>;
    objects: Record<string, TelegramObject | ObjectWithEnum>;
}
```

### Fields & Types

Each field in a method or object has a `type` discriminated union:

| `type` value | Meaning |
|---|---|
| `"string"` | Plain string |
| `"number"` | Integer or float |
| `"boolean"` | Boolean |
| `"reference"` | Reference to another object (e.g. `Message`) |
| `"array"` | Array of another type |
| `"one_of"` | Union of types |
| `"file"` | `InputFile` — a file upload field |

### Semantic Type Markers

Fields carry optional `semanticType` markers that convey meaning beyond the raw type:

| `semanticType` | Meaning | How detected |
|---|---|---|
| `"formattable"` | Text that supports entities/parse\_mode | Has `_entities` or `_parse_mode` sibling field |
| `"markup"` | Keyboard/reply markup object | Object name matches keyboard types |
| `"updateType"` | Update discriminator string | Field used in event routing |

Example — `sendMessage.text` has `semanticType: "formattable"` because the method also has `parse_mode` and `entities` parameters.

### InputFile Detection

String fields that accept file uploads (detected via "More information on Sending Files" link in the description) are automatically converted to `one_of` unions:

```ts
// Instead of: { type: "string" }
// You get:
{
    type: "one_of",
    variants: [
        { type: "file" },     // InputFile — local upload
        { type: "string" },   // file_id or URL
    ]
}
```

### Currencies Enum

The parser fetches Telegram's `currencies.json` and synthesizes a `Currencies` enum object, including `XTR` (Telegram Stars) which isn't in the currencies file:

```ts
schema.objects.Currencies;
// {
//   name: "Currencies",
//   type: "enum",
//   values: ["AED", "AFN", ..., "XTR", "ZMW"]
// }
```

Fields typed as ISO 4217 currency codes (like `currency` in `sendInvoice`) automatically reference this enum.

## Exported Types

```ts
import type {
    BotAPISchema,
    Method,
    TelegramObject,
    ObjectWithEnum,
    Field,
    FieldType,
    FieldFile,
    SemanticType,
} from "@gramio/schema-parser";
```

## Use Case: Custom Type Generator

```ts
import { parseSchema } from "@gramio/schema-parser";

const schema = await parseSchema();

for (const [name, method] of Object.entries(schema.methods)) {
    const returnType = method.returns;
    console.log(`${name} → ${JSON.stringify(returnType)}`);
}
```

## See Also

* [`@gramio/types`](/types) — the generated TypeScript types powered by this package
* [Telegram Bot API](https://core.telegram.org/bots/api) — the source documentation

---

---
url: 'https://gramio.dev/api/session.md'
---
[GramIO API Reference](../../../index.md) / @gramio/session/dist

# @gramio/session/dist

## Interfaces

| Interface | Description |
| ------ | ------ |
| [SessionOptions](interfaces/SessionOptions.md) | Options types from [session](#session) plugin |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [Events](type-aliases/Events.md) | Telegram events that support session |
| [SessionData](type-aliases/SessionData.md) | Helper type: If Lazy is true, wraps Data in Promise, otherwise returns Data as-is |

## Functions

### session()

> **session**<`Data`, `Key`, `Lazy`>(`options?`): [`Plugin`](../../../gramio/classes/Plugin.md)<{ }, [`DeriveDefinitions`](../../../gramio/type-aliases/DeriveDefinitions.md) & `object`>

Defined in: session/index.d.ts:137

Session plugin

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Data` | `unknown` |
| `Key` *extends* `string` | `"session"` |
| `Lazy` *extends* `boolean` | `false` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`SessionOptions`](interfaces/SessionOptions.md)<`Data`, `Key`, `Lazy`> |

#### Returns

[`Plugin`](../../../gramio/classes/Plugin.md)<{ }, [`DeriveDefinitions`](../../../gramio/type-aliases/DeriveDefinitions.md) & `object`>

#### Examples

```ts
import { Bot } from "gramio";
import { session } from "@gramio/session";

const bot = new Bot(process.env.token!)
    .extend(
        session({
            key: "sessionKey",
            initial: () => ({ apple: 1 }),
        })
    )
    .on("message", (context) => {
        context.send(`🍏 apple count is ${++context.sessionKey.apple}`);
    })
    .onStart(console.log);

bot.start();
```

```ts
// Lazy sessions - only load when accessed
const bot = new Bot(process.env.token!)
    .extend(
        session({
            lazy: true,
            initial: () => ({ count: 0 }),
        })
    )
    .on("message", async (context) => {
        const session = await context.session;
        session.count++;
    });
```

---

---
url: 'https://gramio.dev/api/storage.md'
---
[GramIO API Reference](../../../index.md) / @gramio/storage/dist

# @gramio/storage/dist

## Interfaces

| Interface | Description |
| ------ | ------ |
| [Storage](interfaces/Storage.md) | Type of base storage which should implement all of storages |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [InMemoryStorageMap](type-aliases/InMemoryStorageMap.md) | Type of in memory storage map |

## Functions

### inMemoryStorage()

> **inMemoryStorage**<`Data`>(`map?`): [`Storage`](interfaces/Storage.md)<`Data`>

Defined in: storage/index.d.ts:85

in memory storage. Can be used by **default** in plugins

#### Type Parameters

| Type Parameter |
| ------ |
| `Data` *extends* `Record`<`string`, `any`> |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `map?` | [`InMemoryStorageMap`](type-aliases/InMemoryStorageMap.md)<`Data`\[keyof `Data`]> |

#### Returns

[`Storage`](interfaces/Storage.md)<`Data`>

---

---
url: 'https://gramio.dev/guides/for-beginners/4.md'
---

# Coming Soon

Check back soon for updates!

---

---
url: 'https://gramio.dev/plugins/official/auto-answer-callback-query.md'
---

# Auto answer callback query plugin

[![npm](https://img.shields.io/npm/v/@gramio/auto-answer-callback-query?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/auto-answer-callback-query)
[![JSR](https://jsr.io/badges/@gramio/auto-answer-callback-query)](https://jsr.io/@gramio/auto-answer-callback-query)
[![JSR Score](https://jsr.io/badges/@gramio/auto-answer-callback-query/score)](https://jsr.io/@gramio/auto-answer-callback-query)

This plugin auto answer on `callback_query` events with `answerCallbackQuery` method if you haven't done it yet.

### Installation

::: pm-add @gramio/auto-answer-callback-query
:::

```ts
import { Bot, InlineKeyboard } from "gramio";
import { autoAnswerCallbackQuery } from "@gramio/auto-answer-callback-query";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(autoAnswerCallbackQuery())
    .command("start", (context) =>
        context.send("Hello!", {
            reply_markup: new InlineKeyboard()
                .text("test", "test")
                .text("test2", "test2"),
        })
    )
    .callbackQuery("test", () => {
        // The plugin will call an answerCallbackQuery method since you didn't do it
        return context.send("Hii");
    })
    .callbackQuery("test2", (context) => {
        // you already answered so plugin won't try to answer
        return context.answer("HII");
    });
```

### Params

You can pass params for [answerCallbackQuery](https://core.telegram.org/bots/api#answercallbackquery) method

```ts
bot.extend(
    autoAnswerCallbackQuery({
        text: "Auto answer",
        show_alert: true,
    })
);
```

> \[!IMPORTANT]
> This plugin hijack the `context.answerCallbackQuery` (`context.answer` too) method to determine if the callback query was already answered or not. Please avoid global usage of `bot.api.answerCallbackQuery` method in context because plugin can not work properly in this case.

---

---
url: 'https://gramio.dev/plugins/official/auto-retry.md'
---

# Auto retry plugin

[![npm](https://img.shields.io/npm/v/@gramio/auto-retry?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/auto-retry)
[![JSR](https://jsr.io/badges/@gramio/auto-retry)](https://jsr.io/@gramio/auto-retry)
[![JSR Score](https://jsr.io/badges/@gramio/auto-retry/score)](https://jsr.io/@gramio/auto-retry)

A plugin that catches errors with the `retry_after` field (**rate limit** errors), **waits** for the specified time and **repeats** the API request.

### Installation

::: pm-add @gramio/auto-retry
:::

### Usage

```ts
import { Bot } from "gramio";
import { autoRetry } from "@gramio/auto-retry";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(autoRetry())
    .command("start", async (context) => {
        for (let index = 0; index < 100; index++) {
            await context.reply(`some ${index}`);
        }
    })
    .onStart(console.log);

bot.start();
```

---

---
url: 'https://gramio.dev/plugins/official/autoload.md'
---

# Autoload Plugin

[![npm](https://img.shields.io/npm/v/@gramio/autoload?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/autoload)
[![JSR](https://jsr.io/badges/@gramio/autoload)](https://jsr.io/@gramio/autoload)
[![JSR Score](https://jsr.io/badges/@gramio/autoload/score)](https://jsr.io/@gramio/autoload)

Autoload commands plugin for GramIO with [`Bun.build`](#bun-build-usage) support.

### Installation

::: pm-add @gramio/autoload
:::

## Usage

> [full example](https://github.com/gramiojs/autoload/tree/main/example)

> \[!IMPORTANT]
> Please read about [Lazy-load plugins](https://gramio.dev/plugins/lazy-load)

## Register the plugin

```ts twoslash
// index.ts
import { Bot } from "gramio";
import { autoload } from "@gramio/autoload";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(await autoload())
    .onStart(console.log);

bot.start();

export type BotType = typeof bot;
```

## Create command

```ts
// commands/command.ts
import type { BotType } from "..";

export default (bot: BotType) =>
    bot.command("start", (context) => context.send("hello!"));
```

## Options

| Key               | Type                                                                                               | Default                    | Description                                                               |
| ----------------- | -------------------------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------- |
| pattern?          | string | string\[]                                                                                 | "\*\*/\*.{ts,js,cjs,mjs}" | [Glob patterns](https://en.wikipedia.org/wiki/Glob_\(programming\))       |
| path?             | string                                                                                             | "./commands"               | Path to the folder                                                        |
| import?           | string | (file: any) => string                                                                    | "default"                  | Import a specific `export` from a file                                    |
| failGlob?         | boolean                                                                                            | true                       | Throws an error if no matches are found                                   |
| skipImportErrors? | boolean                                                                                            | false                      | Skip imports where needed `export` not defined                            |
| onLoad?           | (params: { absolute: string; relative: string }) => unknown                                        |                            | Hook that is called when loading a file                                   |
| onFinish?         | (paths: { absolute: string; relative: string }\[]) => unknown;                                      |                            | Hook that is called after loading all files                               |
| fdir?             | [Options](https://github.com/thecodrr/fdir/blob/HEAD/documentation.md#method-chaining-alternative) |                            | Options to configure [fdir](https://github.com/thecodrr/fdir)             |
| picomatch?        | [PicomatchOptions](https://github.com/micromatch/picomatch?tab=readme-ov-file#picomatch-options)   |                            | Options to configure [picomatch](https://www.npmjs.com/package/picomatch) |

### [Bun build](https://bun.sh/docs/bundler) usage

You can use this plugin with [`Bun.build`](https://bun.sh/docs/bundler), thanks to [esbuild-plugin-autoload](https://github.com/kravetsone/esbuild-plugin-autoload)!

```ts
// @filename: build.ts
import { autoload } from "esbuild-plugin-autoload"; // default import also supported

await Bun.build({
    entrypoints: ["src/index.ts"],
    target: "bun",
    outdir: "out",
    plugins: [autoload("./src/commands")],
}).then(console.log);
```

Then, build it with `bun build.ts` and run with `bun out/index.ts`.

### [Bun compile](https://bun.sh/docs/bundler/executables) usage

You can bundle and then compile it into a [single executable binary file](https://bun.sh/docs/bundler/executables)

```ts
import { autoload } from "esbuild-plugin-autoload"; // default import also supported

await Bun.build({
    entrypoints: ["src/index.ts"],
    target: "bun",
    outdir: "out",
    plugins: [autoload("./src/commands")],
}).then(console.log);

await Bun.$`bun build --compile out/index.js`;
```

> \[!WARNING]
> You cannot use it in `bun build --compile` mode without extra step ([Feature issue](https://github.com/oven-sh/bun/issues/11895))

[Read more](https://github.com/kravetsone/esbuild-plugin-autoload)

---

---
url: 'https://gramio.dev/changelogs/2026-02-15.md'
---

# Bot API 9.4, Views System, OpenTelemetry & `streamMessage`

**February 8 – 15, 2026**

An absolutely packed week. GramIO catches up to **Bot API 9.4** with 8 new contexts, ships a brand-new **views/template system**, launches **OpenTelemetry** and **Sentry** plugins, adds an `onApiCall` hook for API instrumentation, introduces `streamMessage` for live-typing drafts, brings **button styling** to keyboards, and delivers Node.js support for SQLite storage plus Bun-native Redis. Let's go.

## gramio v0.4.14 — `onApiCall` Hook & Better Stack Traces

[`b54d121`](https://github.com/gramiojs/gramio/commit/b54d121) [`54ece76`](https://github.com/gramiojs/gramio/commit/54ece76) [`7e48c24`](https://github.com/gramiojs/gramio/commit/7e48c24)

### New hook: `onApiCall` for API call instrumentation

The 7th hook joins the family. `onApiCall` wraps the entire API call lifecycle, enabling tracing, logging, metrics — anything you want around every outgoing Telegram request. It works like middleware with `next()`:

```ts
bot.onApiCall(async (context, next) => {
    console.log(`→ ${context.method}`);
    const start = Date.now();
    const result = await next();
    console.log(`← ${context.method} (${Date.now() - start}ms)`);
    return result;
});
```

You can scope it to specific methods:

```ts
bot.onApiCall("sendMessage", async (context, next) => {
    // only fires for sendMessage calls
    return next();
});
```

Multiple hooks compose like middleware — the first registered wraps everything. Works in both `Bot` and `Plugin`. This is what powers the new OpenTelemetry plugin under the hood.

### Error stack traces now point to your code

`TelegramError` now captures the call site where you made the API call. When `bot.api.sendMessage(...)` fails, the stack trace points to *your* line of code, not framework internals. No config needed — it just works.

### Dependencies

* `@gramio/contexts` bumped to `^0.4.0`
* `@gramio/keyboards` bumped to `^1.3.0`
* `@gramio/types` bumped to `^9.4.0`

## @gramio/contexts v0.4.0 — Bot API 9.2 / 9.3 / 9.4

[`ea3049f`](https://github.com/gramiojs/contexts/commit/ea3049f) [`aa3ff6d`](https://github.com/gramiojs/contexts/commit/aa3ff6d) [`3df81eb`](https://github.com/gramiojs/contexts/commit/3df81eb) [`524ba8b`](https://github.com/gramiojs/contexts/commit/524ba8b) [`13564e6`](https://github.com/gramiojs/contexts/commit/13564e6)

### `streamMessage` — live-typing message drafts

Stream text chunks to the chat with live typing previews. Each chunk updates a draft in real-time via `sendMessageDraft`, and the message auto-finalizes via `sendMessage` when a 4096-character segment completes. Perfect for AI/LLM streaming responses:

```ts
bot.command("stream", async (context) => {
    const chunks = generateTextChunks(); // Iterable or AsyncIterable
    const messages = await context.streamMessage(chunks);
});
```

Accepts `Iterable<MessageDraftPiece>` or `AsyncIterable<MessageDraftPiece>` where each piece is a string or `{ text, entities?, draft_id? }`. Supports `AbortSignal` for cancellation.

### Bot API 9.2 — Suggested posts & direct messages

8 new contexts and structures for the suggested posts lifecycle:

* `SuggestedPostApprovedContext`, `SuggestedPostApprovalFailedContext`, `SuggestedPostDeclinedContext`, `SuggestedPostPaidContext`, `SuggestedPostRefundedContext`
* `DirectMessagesTopic` structure
* `Chat.isDirectMessages`, `ChatFullInfo.parentChat`, `ChatAdministratorRights.canManageDirectMessages`
* `Gift.publisherChat`, `UniqueGift.publisherChat`
* `Message.suggestedPostInfo`, `Message.directMessagesTopic`, `Message.isPaidPost`

### Bot API 9.3 — Gift upgrades, new structures

* `GiftUpgradeSentContext` — service message about gift upgrades
* `sendMessageDraft()` method on SendMixin
* New structures: `GiftBackground`, `UniqueGiftColors`, `UserRating`
* Extended `Gift` with `isPremium`, `background`, `uniqueGiftVariantCount`
* Extended `ChatFullInfo` with `rating`, `uniqueGiftColors`, `paidMessageStarCount`

### Bot API 9.4 — Chat ownership, video quality, profile audios

* `ChatOwnerLeftContext`, `ChatOwnerChangedContext` — track chat ownership changes
* `VideoQuality` structure with `codec` (`"h265"` | `"av01"`)
* `UserProfileAudios` structure
* Extended `VideoAttachment` with `qualities` getter
* Extended `UniqueGiftModel` with `rarity` (`"uncommon"` | `"rare"` | `"epic"` | `"legendary"`)
* Extended `UniqueGift` with `isBurned`
* Extended `User` with `allowsUsersToCreateTopics()`

## @gramio/views — Template System for Reusable Message Views (NEW)

[`4de789b`](https://github.com/gramiojs/views/commit/4de789b) [`cd3b934`](https://github.com/gramiojs/views/commit/cd3b934) [`944a5fb`](https://github.com/gramiojs/views/commit/944a5fb) [`c7521ae`](https://github.com/gramiojs/views/commit/c7521ae) [`b2f917b`](https://github.com/gramiojs/views/commit/b2f917b)

A brand-new package for building reusable message templates with automatic send/edit strategy detection. Define views once, render them anywhere — the library figures out whether to send a new message or edit the existing one based on the context type.

### Programmatic views

```ts
import { initViewsBuilder } from "@gramio/views";
import { defineAdapter } from "@gramio/views/define";

const adapter = defineAdapter({
    welcome(name: string) {
        return this.response
            .text(`Hello, ${name}!`)
            .keyboard([[{ text: "Start", callback_data: "start" }]]);
    },
});

const defineView = initViewsBuilder().from(adapter);

bot.derive(["message", "callback_query"], (context) => ({
    render: defineView.buildRender(context, {}),
}));

bot.command("start", (context) => context.render("welcome", "Alice"));
```

### JSON-driven views

Define views as JSON with `{{key}}` interpolation for text, keyboards, and media:

```ts
import { createJsonAdapter } from "@gramio/views/json";

const adapter = createJsonAdapter({
    views: {
        welcome: {
            text: "Hello, {{name}}!",
            reply_markup: {
                inline_keyboard: [
                    [{ text: "Profile {{name}}", callback_data: "profile_{{id}}" }],
                ],
            },
        },
    },
});
```

### Filesystem loading

```ts
import { loadJsonViewsDir } from "@gramio/views/fs";

// views/messages.json → "messages.welcome", "messages.goodbye"
// views/goods/products.json → "goods.products.list"
const views = await loadJsonViewsDir("./views");
```

### i18n support

Two approaches: adapter factory for per-locale JSON files, or custom `resolve` callback for translation keys:

```ts
// Per-locale adapter selection
const defineView = initViewsBuilder<{ locale: string }>()
    .from((globals) => adapters[globals.locale]);

// Or custom resolve for translation keys
const adapter = createJsonAdapter({
    views: { greet: { text: "{{t:hello}}, {{name}}!" } },
    resolve: (key, globals) => {
        if (key.startsWith("t:")) return globals.t(key.slice(2));
    },
});
```

Supports all keyboard types (inline, reply, remove, force reply), single and grouped media with URL interpolation, and globals access via `{{$path}}` syntax.

## @gramio/opentelemetry — Distributed Tracing (NEW)

[`5fe9928`](https://github.com/gramiojs/opentelemetry/commit/5fe9928) [`56789d9`](https://github.com/gramiojs/opentelemetry/commit/56789d9) [`1ba7880`](https://github.com/gramiojs/opentelemetry/commit/1ba7880)

Vendor-neutral distributed tracing for GramIO using OpenTelemetry API. Every update becomes a root span, every API call becomes a child span — zero config, works with any OTEL backend (Jaeger, Grafana, Axiom, etc.).

```ts
import { opentelemetryPlugin } from "@gramio/opentelemetry";

bot.extend(opentelemetryPlugin({
    recordApiParams: true, // record API params as span attributes
}));
```

Trace hierarchy:

```
gramio.update.message (CONSUMER)
  ├── telegram.api/sendMessage (CLIENT)
  ├── telegram.api/deleteMessage (CLIENT)
  └── custom spans via record()
```

Exported utilities: `record(name, fn)` for custom child spans, `getCurrentSpan()`, `setAttributes()`. Integrates seamlessly with Elysia webhooks — GramIO spans automatically nest under HTTP request spans.

## @gramio/sentry — Error Tracking (NEW)

[`47948dd`](https://github.com/gramiojs/sentry/commit/47948dd) [`fb1e8c8`](https://github.com/gramiojs/sentry/commit/fb1e8c8)

Sentry integration with automatic error capture, user identification, breadcrumbs, and optional tracing:

```ts
import { sentryPlugin } from "@gramio/sentry";

bot.extend(sentryPlugin({
    setUser: true,      // auto-set user from context.from
    breadcrumbs: true,  // breadcrumb per update + API call
    tracing: false,     // per-update isolation scopes + spans
}));

// Derived context methods:
bot.command("test", (context) => {
    context.sentry.captureMessage("Something happened");
    context.sentry.setTag("custom", "value");
});
```

Uses `@sentry/core` for runtime-agnostic support (works in both Bun and Node.js).

## @gramio/keyboards v1.3.0 — Button Styling

[`b97e34e`](https://github.com/gramiojs/keyboards/commit/b97e34e)

All button methods now accept an optional `options` parameter for visual styling:

```ts
new InlineKeyboard()
    .text("Delete", "delete", { style: "danger" })
    .text("Confirm", "confirm", {
        style: "success",
        icon_custom_emoji_id: "5368324170671202286",
    });
```

Three styles: `"danger"` (red), `"primary"` (blue), `"success"` (green). Plus `icon_custom_emoji_id` for custom emoji icons next to button text. Works on both `InlineKeyboard` and `Keyboard`.

## @gramio/types v9.4.0

[`177ce3d`](https://github.com/gramiojs/types/commit/177ce3d) [`27149c1`](https://github.com/gramiojs/types/commit/27149c1)

New types for Bot API 9.4: `VideoQuality`, `UserProfileAudios`, `ChatOwnerLeft`, `ChatOwnerChanged`, `UniqueGiftModelRarity`. Button styling types (`KeyboardButtonStyle`, `InlineKeyboardButtonStyle`) are now official. New API methods: `getUserProfileAudios`, `setMyProfilePhoto`, `removeMyProfilePhoto`.

## @gramio/storage-sqlite v1.0.0 — Now Works on Node.js!

[`84ea1b1`](https://github.com/gramiojs/storages/commit/84ea1b1)

The SQLite adapter is no longer Bun-only! It now has dual runtime exports:

* **Bun**: uses `bun:sqlite` (unchanged)
* **Node.js**: uses `node:sqlite` with `DatabaseSync`

The correct implementation is auto-selected based on your runtime — no code changes needed.

## @gramio/storage-redis — Bun Native Redis

[`8190612`](https://github.com/gramiojs/storages/commit/8190612) [`98749d1`](https://github.com/gramiojs/storages/commit/98749d1)

The Redis adapter now supports Bun's built-in `RedisClient` alongside `ioredis`:

```ts
// Auto-selected on Bun — no ioredis needed
import { redisStorage } from "@gramio/storage-redis";
const storage = redisStorage({ url: "redis://localhost:6379" });
```

Dual exports: `@gramio/storage-redis` (auto-detects runtime), `@gramio/storage-redis/ioredis` (explicit), `@gramio/storage-redis/bun` (explicit). The `ioredis` peer dependency is now optional.

## @gramio/test — API Mocking & Chat Simulation

[`f9b670d`](https://github.com/gramiojs/test/commit/f9b670d) [`480cde3`](https://github.com/gramiojs/test/commit/480cde3)

### `onApi` / `offApi` for mocking API responses

```ts
import { apiError } from "@gramio/test";

// Static response
env.onApi("sendMessage", { message_id: 1, chat: { id: 1 }, ... });

// Dynamic handler
env.onApi("getChat", (params) => {
    if (params.chat_id === 123) return chatData;
    return apiError(400, "Chat not found");
});

// Simulate errors with retry_after
env.onApi("sendMessage", apiError(429, "Too Many Requests", { retry_after: 30 }));

env.offApi("sendMessage"); // reset single
env.offApi();              // reset all
```

### Chat objects and user interactions

```ts
const chat = env.createChat();
const user = env.createUser({ first_name: "Alice" });

await user.join(chat);           // emits chat_member + new_chat_members
await user.sendMessage(chat, "Hello!");  // emits message in chat
await user.click("button_data"); // emits callback_query
await user.leave(chat);          // emits chat_member + left_chat_member
```

All API calls are recorded in `env.apiCalls` for assertions.

---

---
url: 'https://gramio.dev/changelogs/2026-03-02.md'
---

# Bot API 9.5 Lands, Rate Limiter Debuts, Composer Gets Superpowers

**February 23 – March 2, 2026**

A massive week for the GramIO ecosystem. Telegram Bot API 9.5 is fully supported — member tags, `date_time` entities, and `can_manage_tags` admin rights. A brand-new `@gramio/rate-limit` plugin arrives with macro-based per-handler throttling. `@gramio/format` learns to parse HTML directly into Telegram entities. `@gramio/composer` ships `EventContextOf`, `ContextOf`, `defineComposerMethods`, and a full Elysia-inspired macro system. Plus `@gramio/views` gains sticker/voice/video\_note support, `create-gramio` generates CLAUDE.md context files for AI tools, and `@gramio/scenes` gets cross-chain deduplication.

## [Bot API 9.5 — Member Tags & date\_time Entities](https://github.com/gramiojs/gramio/compare/v0.6.2...v0.7.0)

Telegram Bot API 9.5 is now fully supported across the entire ecosystem.

### [Member tags: set, clear, and verify text labels per user](https://github.com/gramiojs/gramio/commit/d3dc668edcdfdf69114cf862de50c7af13677c7a)

Bots can now assign **plain text tags** (up to 16 characters, no emoji) to group and supergroup members. Tags require the `can_manage_tags` administrator right. GramIO exposes this via the new [`setChatMemberTag`](/telegram/methods/setChatMemberTag) method and context shorthand:

```ts
// Set a tag using the context shorthand
bot.command("tag", async (ctx) => {
    if (!ctx.replyToMessage) return ctx.send("Reply to a user to tag them");
    await ctx.replyToMessage.setMemberTag("VIP");
    await ctx.reply("Tag set!");
});

// Remove a tag by passing undefined (or empty string)
await ctx.setMemberTag(undefined);
```

The `ChatMember` type gains new fields:

| Field | Type | Available on |
|---|---|---|
| `tag` | `string` | `ChatMemberMember`, `ChatMemberRestricted` |
| `canEditTag` | `boolean` | `ChatMemberRestricted`, `ChatPermissions` |
| `canManageTags` | `boolean` | `ChatAdministratorRights`, `ChatMemberAdministrator` |
| `senderTag` | `string \| undefined` | `Message` |

To allow other admins to set tags, pass `can_manage_tags: true` to [`promoteChatMember`](/telegram/methods/promoteChatMember).

### [New date\_time MessageEntity type](https://github.com/gramiojs/contexts/commit/116aacd059d0ecf675563bd9800a2fe23dc9bdf3)

Telegram now marks timestamps in messages with `date_time` entities. GramIO surfaces the new fields on `MessageEntity`:

```ts
bot.on("message", (ctx) => {
    const dateEntities = ctx.entities?.filter((e) => e.type === "date_time");
    for (const entity of dateEntities ?? []) {
        console.log(entity.unixTime);       // Unix timestamp
        console.log(entity.dateTimeFormat); // Telegram's format string
    }
});
```

**Updated packages:** `@gramio/types` v9.5.0, `gramio` v0.7.0, `@gramio/contexts` v0.5.0, `@gramio/keyboards` v1.3.1

## [@gramio/rate-limit v0.0.1 — Rate Limiting via Macros](https://github.com/gramiojs/rate-limiter/commit/4e9f95cf1b18fffed297d2884f6d683d338f6e85)

### [Brand-new rate limiting plugin with per-handler throttling](https://github.com/gramiojs/rate-limiter/commit/4e9f95cf1b18fffed297d2884f6d683d338f6e85)

`@gramio/rate-limit` is a new official plugin that protects your bot handlers from abuse using sliding-window rate limiting. The key design choice: it uses GramIO's **macro system** for per-handler options instead of imperative `if (!await ctx.rateLimit(...)) return` checks.

```ts
import { Bot } from "gramio";
import { rateLimit } from "@gramio/rate-limit";

const bot = new Bot(process.env.BOT_TOKEN!)
    .extend(
        rateLimit({
            // Optional: plug in Redis, SQLite, Cloudflare KV…
            // storage: redisStorage(redis),
            onLimitExceeded: async (ctx) => {
                if (ctx.is("message")) await ctx.reply("Too many requests, slow down!");
            },
        }),
    );

// Throttle per handler — no if-checks needed in handler body
bot.command("pay", (ctx) => {
    // process payment
}, { rateLimit: { limit: 3, window: 60 } });

bot.command("help", (ctx) => ctx.reply("Help text"), {
    rateLimit: {
        id: "help",
        limit: 20,
        window: 60,
        onLimitExceeded: (ctx) => ctx.reply("Too many /help requests!"),
    },
});

await bot.start();
```

The plugin ships with **in-memory storage** out of the box. Swap in Redis, SQLite, or Cloudflare KV by passing a `storage` option from `@gramio/storages`.

> **Note on the export name:** The plugin function was renamed from `rateLimitPlugin` to `rateLimit` in the same release. Use `rateLimit` — the old name is gone.

## [@gramio/format v0.5.0 — Parse HTML into Telegram Entities](https://github.com/gramiojs/format/compare/v0.4.0...v0.5.0)

### [htmlToFormattable(): send HTML content without parse\_mode](https://github.com/gramiojs/format/commit/77463cb24219ec94d9da4fb21a8771e668c45859)

`@gramio/format` v0.5.0 adds `htmlToFormattable()` — a new sub-module that converts HTML markup into GramIO's `FormattableString` format. This is a perfect complement to `markdownToFormattable()` for when your content source produces HTML (CMS outputs, TipTap, ProseMirror, LLM-generated HTML, etc.).

The approach is the same as with Markdown: parse locally into entities, send without any `parse_mode`. Invalid or partial HTML degrades gracefully to plain text instead of erroring.

Install the peer dependency first:

::: pm-add node-html-parser
:::

Then import from the `@gramio/format/html` sub-path:

```ts
import { htmlToFormattable } from "@gramio/format/html";
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN!);

bot.command("start", (ctx) => {
    const content = `<h1>Hello!</h1><p><strong>Bold</strong> and <em>italic</em></p>
<ul><li>item one</li><li>item two</li></ul>
<p>Visit <a href="https://gramio.dev">gramio.dev</a></p>`;

    ctx.send(htmlToFormattable(content));
});

await bot.start();
```

**Supported HTML elements:**

| HTML | Telegram entity |
|---|---|
| `<b>`, `<strong>` | bold |
| `<i>`, `<em>` | italic |
| `<u>` | underline |
| `<s>`, `<del>`, `<strike>` | strikethrough |
| `<code>` | code |
| `<pre><code class="language-js">` | pre (with language) |
| `<blockquote>` | blockquote |
| `<a href="...">` | text\_link |
| `<h1>`–`<h6>` | bold |
| `<ul>`, `<ol>`, `<li>` | plain text with bullet/number |
| `<br>` | newline |

> **Note:** This API may change in the future as it stabilizes.

### [join() now accepts FormattableString arrays directly](https://github.com/gramiojs/format/commit/3f86dac)

The `join()` helper gains a new overload: you can pass an array of `FormattableString` objects directly without a mapping function:

```ts
import { join, bold, italic } from "@gramio/format";

const items: FormattableString[] = [bold("one"), italic("two"), "three"];

// New: pass the array directly
const result = join(items, "\n");
// Before you needed: join(items, (x) => x, "\n")
```

## [@gramio/composer v0.3.3 — EventContextOf, ContextOf, Macro System](https://github.com/gramiojs/composer/compare/v0.2.0...v0.3.3)

### [EventContextOf\<T, E>: per-event derive visibility in custom methods](https://github.com/gramiojs/composer/commit/6dae6fc0fb71859d4c2f100a5617c1d27c34f684)

`EventContextOf<TComposer, TEvent>` is a new utility type that extracts the **full context** for a specific event from a composer instance — including both global and per-event derives. This is what you need when writing custom methods that use `.derive(['event1'])` to scope enrichment:

```ts
import type { EventContextOf } from "@gramio/composer";

// Per-event derive: only visible in 'message' handlers
composer.derive(['message'], () => ({ messageData: "..." }));

// EventContextOf extracts both global + per-event derives for 'message'
type MessageCtx = EventContextOf<typeof composer, 'message'>;
// MessageCtx includes 'messageData'
```

### [ContextOf\<T> and defineComposerMethods(): type-safe custom methods with derives](https://github.com/gramiojs/composer/commit/b79282ff0bd8af2a6c8fd88f9e0c335fcd46b50c)

Writing custom methods that receive accumulated derives used to require complex generic gymnastics. Now there are two clean tools:

**`ContextOf<T>`** — extracts `TOut` (the fully accumulated context type) from a composer instance:

```ts
import type { ContextOf } from "@gramio/composer";

type Ctx = ContextOf<typeof myComposer>; // infers accumulated context
```

**`defineComposerMethods()`** — required when your custom methods have generic signatures, because TypeScript can't infer generics through nested types:

```ts
import { defineComposerMethods, createComposer } from "@gramio/composer";
import type { ComposerLike, ContextOf, Middleware } from "@gramio/composer";

const methods = defineComposerMethods({
    command<TThis extends ComposerLike<TThis>>(
        this: TThis,
        name: string,
        handler: Middleware<MessageCtx & ContextOf<TThis>>,
    ): TThis {
        return this.on("message", (ctx, next) => {
            if (ctx.text === `/${name}`) return handler(ctx, next);
            return next();
        });
    },
});

const { Composer } = createComposer<BaseCtx, EventMap, typeof methods>({
    discriminator: (ctx) => ctx.updateType,
    methods,
});

// Derives flow into the handler automatically — zero annotation:
new Composer()
    .derive(() => ({ user: { id: 1 } }))
    .command("start", (ctx) => {
        ctx.user.id; // ✅ typed
    });
```

### [Macro system: Elysia-inspired per-handler options](https://github.com/gramiojs/composer/commit/7b6696e)

`macro()` lets you register reusable behaviors that handlers activate declaratively via an options object — no manual `if (!await ctx.check()) return` patterns:

```ts
bot.macro("adminOnly", {
    preHandler: async (ctx, next) => {
        if (ctx.from?.id !== ADMIN_ID) return ctx.reply("Admins only");
        return next();
    },
});

// Activate in any handler by passing options:
bot.command("ban", handler, { adminOnly: true });
bot.command("kick", handler, { adminOnly: true });
```

The macro runs before the handler body. Multiple macros compose in registration order.

### [WeakMap-backed property isolation fix](https://github.com/gramiojs/composer/commit/7e80716)

A critical bug affecting GramIO context properties is fixed. Previously, `group()` and `extend()` used `Object.create(ctx)` for isolation — which broke WeakMap-backed private fields (like GramIO's lazy-cached getters `ctx.text`, `ctx.from`) because prototype chain lookups don't work with WeakMaps.

The fix replaces `Object.create(ctx)` with a **snapshot/restore** strategy: capture keys before execution, delete new keys after, restore original values. GramIO context properties in isolation groups now work correctly.

## [@gramio/views v0.1.1 — Sticker, Voice, Video Note Support](https://github.com/gramiojs/views/compare/v0.0.0...v0.1.1)

### [Views now send stickers, voice messages, and video notes](https://github.com/gramiojs/views/commit/bcae6014d54ee72ba0133b2667475a9a81dbe180)

`@gramio/views` v0.1.1 expands the supported media types to include `sticker`, `voice`, and `video_note`. Each has a different edit behavior since Telegram doesn't allow changing these media files after sending:

| Media type | Send | Edit behavior |
|---|---|---|
| `sticker` | ✅ | `editReplyMarkup` only (keyboard update) |
| `voice` | ✅ | `editCaption` + keyboard |
| `video_note` | ✅ | `editReplyMarkup` only (keyboard update) |

```ts
import { defineView } from "@gramio/views";

const stickerView = defineView().render(function (fileId: string) {
    this.media({ type: "sticker", media: fileId });
    this.keyboard(/* ... */);
});
```

Render methods (`renderWithContext`, `performSend`, `performEdit`) now return proper typed values (`RenderSendResult`, `RenderResult`) instead of `void`.

## [@gramio/scenes — Cross-Chain Deduplication & EventComposer extend](https://github.com/gramiojs/scenes/commit/13be794f76ce599569e7130e7c7f098c2fd45fb0)

### [Plugins extended at bot level are no longer re-applied in scenes](https://github.com/gramiojs/scenes/commit/13be794f76ce599569e7130e7c7f098c2fd45fb0)

If you extend a plugin at the bot level, entering a scene used to re-apply it — causing double middleware execution. The scene engine now checks the bot's main composer for already-applied plugins and skips them:

```ts
const authPlugin = new Plugin("auth").derive(() => ({ user: getUser() }));

const bot = new Bot(token)
    .extend(authPlugin)   // ← applied here
    .extend(scenes);      // scenes skip authPlugin inside scene chains
```

### [Scenes can now extend() with EventComposers](https://github.com/gramiojs/scenes/commit/8ddbabc)

`scene.extend()` now accepts `EventComposer` instances in addition to `Plugin` objects, enabling type-safe per-event derives inside scenes:

```ts
const echoScene = new Scene("echo")
    .extend(myEventComposer) // ← new: EventComposer accepted
    .on("message", (ctx) => ctx.send(ctx.text!));
```

## [create-gramio v2.0.0–v2.0.3 — AI Tools, Broadcast, CLI Presets](https://github.com/gramiojs/create-gramio/compare/v1.x...v2.0.3)

### [CLAUDE.md generation for AI coding agents](https://github.com/gramiojs/create-gramio/commit/eb88688)

`npm create gramio@latest` now generates a `CLAUDE.md` file in your project root — a context file for AI coding agents (Claude Code, Cursor, etc.) explaining your bot's tech stack, architecture, key commands, and which plugins are enabled.

### [AI Skills opt-in for GramIO knowledge](https://github.com/gramiojs/create-gramio/commit/1b131fe)

New projects can opt in to installing GramIO's AI Skills (`bunx skills add`) during scaffolding — enabled by default in recommended and full presets. Skills give your AI assistant deep GramIO knowledge with examples and plugin references.

### [Broadcast plugin support](https://github.com/gramiojs/create-gramio/commit/4b250ed)

The scaffolder now includes `@gramio/broadcast` as an optional plugin choice (with Redis and graceful shutdown wired up automatically).

### [CLI argument parsing and presets](https://github.com/gramiojs/create-gramio/commit/da7da87)

Full CLI argument parsing landed: `npm create gramio@latest ./bot --preset=recommended --orm=drizzle --linter=biome` — no interactive prompts needed for CI or scripted setups. Three presets: `minimal`, `recommended`, `full`.

## [@gramio/files v0.3.2 — Buffer → Uint8Array Fix](https://github.com/gramiojs/files/commit/496423f1b835ddaf4b448da700aa81e42fd285df)

`Buffer` objects are now properly converted to `Uint8Array` before being passed to the `File` constructor, fixing an incompatibility with environments that don't extend `Uint8Array` with `Buffer` (e.g. some Bun builds). `undefined` values in form data are now skipped instead of serialized.

## [Documentation Site — Major Content Push](https://github.com/gramiojs/documentation/compare/7bed05f...a28836f)

The docs site received a massive content update this cycle — new pages, rewrites, and guides across the board.

### [Homepage rewrite: type-safety first, with live code tabs](https://github.com/gramiojs/documentation/commit/82656d3)

The homepage has a completely new structure. The hero messaging shifts from "create bots with convenience" to "build bots the right way" with type-safety as the central theme. A new **"See it in action"** section adds five interactive code tabs covering Commands & Formatting, Keyboards & Callbacks, I18n, Scenes, and Composer — each showing real GramIO patterns with `derive()`, `CallbackData`, `format`, and `guard()`.

### [New Introduction page with framework comparison](https://github.com/gramiojs/documentation/commit/4cf8e62)

A new [`/introduction`](/introduction) page explains GramIO's design philosophy with concrete examples of type propagation, formatting, and plugin composition. Includes a comparison table vs grammY and Telegraf covering type propagation, formatting approach, multi-runtime support, test utilities, and scenes.

### [Get Started guide rewrite](https://github.com/gramiojs/documentation/commit/b3dbe82)

The get-started guide is rebuilt from scratch with a streamlined onboarding flow, comprehensive code examples (commands, formatting, keyboards, derive, middleware), and a production pattern section explaining the shared plugin Composer architecture used in real projects.

### [New Composer guide: modular bot architecture](https://github.com/gramiojs/documentation/commit/37b191a)

A new [`/guides/composer`](/guides/composer) page documents how to structure multi-file bots using the Composer as a module system — file-per-feature pattern, sharing context via `derive()`/`decorate()` with `.as("scoped")`, `ContextOf` typing for extracted handlers, static dependencies, and a suggested file structure. Includes a Composer vs Plugin comparison table.

### [Four migration guides added](https://github.com/gramiojs/documentation/commit/4cf8e62)

Step-by-step migration guides with side-by-side code comparisons for developers switching from other frameworks:

* **[From grammY](/guides/migration-from-grammy)** — context shortcuts, middleware, keyboards, sessions
* **[From Telegraf](/guides/migration-from-telegraf)** — `Telegraf` → `Bot`, `.action()` → `.callbackQuery()`, `ctx.telegram` → `ctx.api`
* **[From puregram](/guides/migration-from-puregram)** — handler style, command registration, reply methods
* **[From node-telegram-bot-api](/guides/migration-from-ntba)** — callback-based → async/await, full TypeScript patterns

### [Cheat Sheet expanded with derive, guards, scenes, i18n, testing](https://github.com/gramiojs/documentation/commit/b397213)

The [Cheat Sheet](/cheat-sheet) gets a full expansion: per-request and per-update-type `derive()` patterns, `decorate()` for static values, `adminOnly`/`textOnly` guard examples with type narrowing, multi-step scenes with `ask()`, i18n pluralization, and `TelegramTestEnvironment` testing patterns. Quick navigation anchors added to all sections.

### [Guides index restructured as a learning path](https://github.com/gramiojs/documentation/commit/264ad76)

The guides index is rebuilt as a structured learning path: a beginner series table, topic sections (Bot Setup, Payments, Filtering, AI & Tooling, Migration), and a quick references section with links to all key pages.

### [Filters guide + @gramio/schema-parser ecosystem page](https://github.com/gramiojs/documentation/commit/ac2ed26)

A new filters guide covers filter-only `.on()` with auto-discovery via `CompatibleEvents`, inline filters, and standalone predicates (`reply`, `isBot`, `isPremium`, `forwardOrigin`, `senderChat`). A new `@gramio/schema-parser` ecosystem page documents the native TypeScript Telegram API schema parser.

### [allow\_paid\_broadcast documented in rate-limits guide](https://github.com/gramiojs/documentation/commit/c3b3a0f)

The rate-limits guide gains a new section on `allow_paid_broadcast`: enables up to 1,000 messages/second at 0.1 Stars per message, with a warning about checking bot balance via @BotFather before large campaigns.

### [cache\_time tip added to inline query guide](https://github.com/gramiojs/documentation/commit/b9406cf)

The inline query guide now documents that `context.answer()` accepts all `answerInlineQuery` parameters as a second argument, with `cache_time` (default 300 s) as the most useful. Recommends `cache_time: 0` for dynamic results and during development.

---

---
url: 'https://gramio.dev/bot-class.md'
---

# Main bot class

[`Bot`](https://jsr.io/@gramio/core/doc/~/Bot) - the main class of the framework. You use it to interact with the [Telegram Bot API](/bot-api).

## [Constructor](https://jsr.io/@gramio/core/doc/~/Bot#constructors)

There are [two ways](https://jsr.io/@gramio/core/doc/~/Bot#constructors) to pass the token and parameters.

1. Pass the token as the first argument and (optionally) options

```ts
const bot = new Bot(process.env.BOT_TOKEN, {
    api: {
        fetchOptions: {
            headers: {
                "X-Hi-Telegram": "10",
            },
        },
    },
});
```

2. Pass the options with the required `token` field

```ts
const bot = new Bot({
    token: process.env.BOT_TOKEN,
    api: {
        fetchOptions: {
            headers: {
                "X-Hi-Telegram": "10",
            },
        },
    },
});
```

### Bot info

When the bot begins to listen for updates, `GramIO` retrieves information about the bot to verify if the **bot token is valid**
and to utilize some bot metadata. For example, this metadata will be used to strip bot mentions in commands.
If you set it up, `GramIO` will not send a `getMe` request on startup.

```ts
const bot = new Bot(process.env.BOT_TOKEN, {
    info: process.env.NODE_ENV === "production" ?
		 {
					id: 1,
					is_bot: true,
					first_name:
						"Bot example",
					username: "example_bot",
                    // ..
				}
			 : undefined
    },
});
```

> \[!IMPORTANT]
> You should set this up when **horizontally scaling** your bot (because `rate limits` on `getMe` method and **faster start up time**) or working in **serverless** environments.

### Default plugins

Some plugins are used by default, but you can disable them.

```ts
const bot = new Bot(process.env.BOT_TOKEN, {
    plugins: {
        // disable formatting. All format`` will be text without formatting
        format: false,
    },
});
```

## API options

### fetchOptions

Configure [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Window/fetch) [parameters](https://developer.mozilla.org/en-US/docs/Web/API/RequestInit)

```ts
const bot = new Bot(process.env.BOT_TOKEN, {
    api: {
        fetchOptions: {
            headers: {
                "X-Hi-Telegram": "10",
            },
        },
    },
});
```

### baseURL

URL which will be used to send requests to. `"https://api.telegram.org/bot"` by default.

```ts
const bot = new Bot(process.env.BOT_TOKEN, {
    api: {
        // random domain
        baseURL: "https://telegram.io/bot",
    },
});
```

### useTest

Should we send requests to `test` data center? `false` by default.
The test environment is completely separate from the main environment, so you will need to create a new user account and a new bot with `@BotFather`.

[Documentation](https://core.telegram.org/bots/webapps#using-bots-in-the-test-environment)

```ts
const bot = new Bot(process.env.BOT_TOKEN, {
    api: {
        useTest: true,
    },
});
```

### retryGetUpdatesWait

Time in milliseconds before calling `getUpdates` again. `1000` by default.

```ts
const bot = new Bot(process.env.BOT_TOKEN, {
    api: {
        retryGetUpdatesWait: 300,
    },
});
```

## Proxy support

In GramIO, it is quite simple to set up a proxy for requests.

### Node.js

```ts
import { ProxyAgent } from "undici";

const proxyAgent = new ProxyAgent("my.proxy.server");

const bot = new Bot(process.env.BOT_TOKEN, {
    api: {
        fetchOptions: {
            dispatcher: proxyAgent,
        },
    },
});
```

> \[!WARNING]
> Despite the fact that `undici` works under the hood of `Node.js`, you'll have to install it. Also make sure you don't have `"lib": ["DOM"]` in your `tsconfig.json`, otherwise you won't see the **dispatcher** property in the **types** (although `undici` will process it anyway).

[Documentation](https://github.com/nodejs/undici/blob/e461407c63e1009215e13bbd392fe7919747ab3e/docs/api/ProxyAgent.md)

### Bun

```ts
const bot = new Bot(process.env.BOT_TOKEN, {
    api: {
        fetchOptions: {
            proxy: "https://username:password@proxy.example.com:8080",
        },
    },
});
```

[Guide](https://bun.sh/guides/http/proxy)

### Deno

```ts
const client = Deno.createHttpClient({
    proxy: { url: "http://host:port/" },
});

const bot = new Bot(process.env.BOT_TOKEN, {
    api: {
        fetchOptions: {
            client,
        },
    },
});
```

> \[!WARNING]
> This API is **unstable**, so you should run it with `deno run index.ts --unstable`

[Documentation](https://docs.deno.com/api/web/~/fetch#function_fetch_1) | [Deno.proxy](https://docs.deno.com/api/deno/~/Deno.Proxy) | [`HTTP_PROXY` environment variables](https://docs.deno.com/runtime/manual/basics/modules/proxies/)

---

---
url: 'https://gramio.dev/guides/ai-skills.md'
---

# Building with AI

GramIO provides AI skills that give your AI assistant deep knowledge of the framework — every API, plugin, pattern, and best practice. Build Telegram bots faster with accurate, up-to-date context instead of the AI guessing.

## Install Skills

The quickest way to add GramIO skills to your project:

::: code-group

```bash [npx]
npx skills add gramiojs/documentation/skills
```

```bash [bunx]
bunx skills add gramiojs/documentation/skills
```

:::

This installs skills for all detected AI agents (Claude Code, Cursor, Cline, etc.) in your project.

### Install Options

```bash
# Install all skills to all agents without prompts
npx skills add gramiojs/documentation/skills --all

# Install only for Claude Code
npx skills add gramiojs/documentation/skills --agent claude-code

# Install globally (available in all projects)
npx skills add gramiojs/documentation/skills --global

# Install a specific skill (@ shorthand)
npx skills add gramiojs/documentation/skills@gramio

# Or with --skill flag
npx skills add gramiojs/documentation/skills --skill gramio

# Skip confirmation prompts (useful for CI/CD)
npx skills add gramiojs/documentation/skills --yes

# List available skills without installing
npx skills add gramiojs/documentation/skills --list
```

### Manual Install

If you prefer to copy manually:

```bash
# Clone and copy the skills directory
git clone https://github.com/gramiojs/documentation.git /tmp/gramio-docs
cp -r /tmp/gramio-docs/skills/* .claude/skills/
```

## Available Skills

### `gramio` — Framework Knowledge (Auto)

The core skill. Activates automatically when you ask about GramIO. Contains:

* **12 runnable examples** — basic bot, keyboards, callbacks, formatting, files, errors, webhooks, sessions, scenes, Telegram Stars, TMA, Docker
* **18 reference docs** — bot configuration, API, context, triggers, hooks, updates & lifecycle, keyboards, formatting, files, CallbackData, storage, Telegram Stars, types, webhooks, rate limits, Docker, TMA, plugin development
* **6 plugin guides** — session, scenes, i18n, autoload, prompt, and others

You don't invoke this skill — your AI assistant reads it automatically when relevant.

### `/gramio-new-bot` — Create New Bot

```bash
/gramio-new-bot my-awesome-bot
```

Scaffolds a new GramIO project with proper structure, TypeScript config, `.env`, and initial handlers. Recommends `create-gramio` or creates manually.

### `/gramio-add-handler` — Add Handler

```bash
/gramio-add-handler command /settings
/gramio-add-handler callback approve_*
/gramio-add-handler hears "hello"
```

Adds a new command, callback query, inline query, hears, or reaction handler with proper typing and context usage.

### `/gramio-add-plugin` — Create Plugin

```bash
/gramio-add-plugin rate-limiter
```

Creates a custom GramIO plugin with `derive()`, custom error types, and TypeScript typing. Can scaffold as inline plugin or standalone package.

## What the Skills Cover

The `gramio` skill gives your AI assistant knowledge of:

| Area | Coverage |
|------|----------|
| Bot constructor | All options, proxy (Node/Bun/Deno), custom API URL, test DC, `info` skip |
| API calls | `bot.api.*`, `suppress: true`, `withRetries()`, type helpers, debugging |
| Triggers | `command`, `hears`, `callbackQuery`, `inlineQuery`, `chosenInlineResult`, `reaction` |
| Context | `derive` (scoped/global), `decorate`, middleware, `context.is()` narrowing |
| Hooks | `onStart`, `onStop`, `onError` (scoped, custom kinds), `preRequest`, `onResponse`, `onResponseError` |
| Keyboards | All button types, layout helpers (`.columns()`, `.pattern()`, `.wrap()`), styling, `RemoveKeyboard`, `ForceReply` |
| Formatting | All entities (`bold`, `italic`, `code`, `pre`, `link`, `mention`, `spoiler`...), `join()`, restrictions |
| Files | `MediaUpload` (path/url/buffer/stream/text), `MediaInput`, download, `Bun.file()` |
| CallbackData | Type-safe schemas with `.number()`, `.string()`, `.pack()`, `queryData` |
| Storage | In-memory, Redis, Cloudflare KV adapters, custom adapters |
| Webhooks | Elysia, Fastify, Hono, Express, Koa, Bun.serve, Deno.serve, tunneling |
| Rate limits | `withRetries()`, broadcasting, `@gramio/broadcast`, BullMQ queues |
| All 11 plugins | Session, Scenes, I18n, Autoload, Prompt, Auto Retry, Media Cache, Media Group, Split, Auto Answer CB, PostHog |
| Plugin development | `Plugin` class, `derive`/`decorate`/`error`/`group`, scaffolding, lazy loading, middleware order |
| Telegram Stars | Invoices, pre-checkout, payments, subscriptions, inline invoices, refunds, test mode |
| TMA | Monorepo scaffold, mkcert HTTPS, `@gramio/init-data`, Elysia auth guard |
| Docker | Dockerfile (Node.js/Bun), multi-stage builds, Docker Compose, graceful shutdown |
| Types | `@gramio/types` standalone package, type helpers, Proxy wrapper, declaration merging |
| Updates & Lifecycle | `start()`/`stop()` options, graceful shutdown (SIGINT/SIGTERM), webhook shutdown order |

## llms.txt

GramIO generates LLM-friendly documentation at build time:

* **[/llms.txt](/llms.txt)** — Table of contents with links to all pages
* **[/llms-full.txt](/llms-full.txt)** — Complete documentation in a single text file

Any AI tool can fetch these URLs for full GramIO context. Additionally, any documentation page URL with `.md` appended returns raw markdown — for example, `https://gramio.dev/bot-api.md` returns the markdown source of the Bot API page.

---

---
url: 'https://gramio.dev/triggers/callback-query.md'
---

# `callbackQuery` Method

The `callbackQuery` method in GramIO is used to handle updates that occur when users interact with [inline keyboard](/keyboards/inline-keyboard) buttons in your Telegram bot. When a user clicks on a button with a callback data payload, Telegram sends a `callback_query` update to your bot. This method allows you to register a handler for these updates, enabling you to perform actions based on the user's interaction.

## Basic Usage

### Handling Callback Queries

To use the `callbackQuery` method, you need to define a trigger and a handler. The trigger determines when the handler should be executed based on the callback data received, and the handler performs the desired action.

```ts twoslash
import { CallbackData, Bot } from "gramio";
const bot = new Bot("");
// ---cut---
const someData = new CallbackData("example").number("id");

bot.callbackQuery(someData, (context) => {
    return context.send(`You clicked button with ID: ${context.queryData.id}`);
    //                                                          ^?
});
```

In this example:

* `someData` is a `CallbackData` instance defining the schema for the callback data.
* The `callbackQuery` method registers a handler that is triggered when the callback data matches `someData`.
* Inside the handler, `context.queryData` provides type-safe access to the callback data.

### Trigger Types

The `callbackQuery` method supports several types of triggers:

* **String Trigger**: The handler is triggered if the callback data exactly matches the specified string.

```ts
bot.callbackQuery("my_callback", (context) => {
    return context.editText("Button clicked!");
});
```

* **RegExp Trigger**: The handler is triggered if the callback data matches the regular expression.

```ts
bot.callbackQuery(/my_(.*)/, (context) => {
    const match = context.queryData;
    context.send(`Matched data: ${match[1]}`);
});
```

* **CallbackData Instance**: The handler is triggered if the callback data matches the `CallbackData` schema.

```ts twoslash
import { CallbackData, Bot } from "gramio";
const bot = new Bot("");
// ---cut---
const someData = new CallbackData("example").number("id");

bot.callbackQuery(someData, (context) => {
    context.send(`Data ID: ${context.queryData.id}`);
    //                                  ^?
});
```

### Handling Callback Data

When a callback query is received, the `context` object includes the following relevant properties:

* `context.data`: The raw callback data payload.
* `context.queryData`: The deserialized data, if a `CallbackData` instance was used for the trigger.

### Example Scenario

Consider a scenario where you want to send a message with an inline keyboard and handle button clicks:

```ts
const buttonData = new CallbackData("action").number("action_id");

bot.command("start", (context) =>
    context.send("Choose an action:", {
        reply_markup: new InlineKeyboard().text(
            "Do Action 1",
            buttonData.pack({ action_id: 1 })
        ),
    })
).callbackQuery(buttonData, (context) => {
    context.send(`You selected action with ID: ${context.queryData.action_id}`);
});
```

In this example:

1. A `/start` command sends a message with an inline keyboard button.
2. The button's callback data is packed using `buttonData.pack()`.
3. The `callbackQuery` method listens for callback queries that match `buttonData`.
4. The handler responds with the ID of the selected action.

## Schema Migrations & `safeUnpack()`

Inline keyboard buttons persist in Telegram's chat history — users can press a button days or weeks after it was sent. If your `CallbackData` schema changes between deployments, old buttons may carry data that no longer matches your schema.

### What's safe to change

| Operation | Safe? | Why |
|---|---|---|
| Add optional field to the end | ✅ Yes | Old data unpacks as `undefined` / default |
| Add default to existing optional | ✅ Yes | Only changes missing-value behavior |
| Add required field | ❌ No | Old data has no value for it |
| Remove a field | ❌ No | Shifts positions of all following fields |
| Reorder fields | ❌ No | Positional format — values land in wrong fields |
| Change field type | ❌ No | Deserialized by wrong algorithm |
| Rename `nameId` | ❌ No | `callbackQuery(schema)` won't match old buttons |

### `safeUnpack()` — for raw `callback_query` handlers

`bot.callbackQuery(schema, handler)` handles filtering and unpacking automatically — inside the handler you always have valid `ctx.queryData`. **You don't need `safeUnpack` there.**

`safeUnpack()` is useful when you handle `callback_query` with `bot.on()` and want to try multiple schemas or gracefully handle outdated buttons:

```ts
const v2Schema = new CallbackData("item").number("id").string("tab", { optional: true });

bot.on("callback_query", (ctx) => {
    const result = v2Schema.safeUnpack(ctx.data ?? "");

    if (!result.success) {
        // old button — schema changed or wrong nameId
        return ctx.answerCallbackQuery({ text: "This button is outdated, please use the new menu." });
    }

    // result.data is fully typed: { id: number; tab: string | undefined }
    return ctx.answerCallbackQuery({ text: `Item ${result.data.id}` });
});
```

The return type is `SafeUnpackResult<T>`, exported from `@gramio/callback-data`:

```ts
import type { SafeUnpackResult } from "@gramio/callback-data";

function handleData(raw: string): SafeUnpackResult<{ id: number }> {
    return mySchema.safeUnpack(raw);
}
```

---

---
url: 'https://gramio.dev/changelogs.md'
---

# Changelogs

Track the latest changes across the GramIO ecosystem. Each entry covers updates from all `gramiojs` repositories, including new features, bug fixes, breaking changes with migration guides, and version bumps.

* [2026-03-02 — Bot API 9.5, Rate Limiter Debuts, HTML-to-Telegram Converter, Composer Superpowers](/changelogs/2026-03-02)
* [2026-02-23 — Testing Gets Richer, CallbackData Gets Safer, TypeScript API Reference Launches](/changelogs/2026-02-23)
* [2026-02-17 — GramIO v0.5.0, Composer Rearchitecture, Observability & Testing Superpowers](/changelogs/2026-02-17)
* [2026-02-15 — Bot API 9.4, Views, OpenTelemetry, `onApiCall`, `streamMessage`](/changelogs/2026-02-15)
* [2026-02-08 — Type-Safe Storage Keys, Scenes `onEnter`, SQLite Adapter](/changelogs/2026-02-08)

---

---
url: 'https://gramio.dev/triggers/chosen-inline-result.md'
---

# chosenInlineResult

The `chosenInlineResult` method in GramIO allows your bot to handle updates when a user selects one of the results returned by an [inline query](/triggers/inline-query). This method is particularly useful when you need to perform additional actions after the user has chosen a specific result from the inline query suggestions.

You should enable [collecting feedback](https://core.telegram.org/bots/inline#collecting-feedback) in [@BotFather](https://telegram.me/botfather).

> To know which of the provided results your users are sending to their chat partners, send [@Botfather](https://telegram.me/botfather) the `/setinlinefeedback` command. With this enabled, you will receive updates on the results chosen by your users.

> Please note that this can create load issues for popular bots – you may receive more results than actual requests due to caching (see the cache\_time parameter in [answerInlineQuery](https://core.telegram.org/bots/api#answerinlinequery)). For these cases, we recommend adjusting the probability setting to receive 1/10, 1/100 or 1/1000 of the results.

We recommend setting this to `100%` so that each click on an [inline query](/triggers/inline-query) result will produce this event.

## Basic Usage

> \[!WARNING]
> You must specify the same matcher (String, Regex, Function) as in [InlineQuery](/triggers/inline-query) to get the results of clicking on this one, or use the `onResult` option in the [InlineQuery](/triggers/inline-query) trigger.

### Handling Chosen Inline Results

The `chosenInlineResult` method registers a handler that is triggered whenever a user selects a result from the inline query response. You can define a trigger that determines when the handler should be invoked, similar to how you define triggers in the `inlineQuery` method.

```ts
bot.chosenInlineResult(/search (.*)/i, async (context) => {
    const selectedResult = context.resultId;
    const queryParams = context.args;

    // You can edit messages only with InlineKeyboard
    if (queryParams && context.inlineMessageId) {
        await context.editText(
            `You selected a result with ID: ${selectedResult} for query: ${queryParams[1]}`
        );
    }
});
```

In this example:

* The bot listens for any result selection that matches the regular expression `search (.*)`.
* If a result is selected that matches the trigger, the bot extracts the result ID and query parameters.
* The bot then edits the message to indicate which result was selected.

### Trigger Types

The `chosenInlineResult` method supports the same types of triggers as the `inlineQuery` method:

* **String Trigger**: The handler is triggered if the `query` exactly matches the specified string.
* **RegExp Trigger**: The handler is triggered if the `query` matches the regular expression.
* **Function Trigger**: The handler is triggered based on a custom function that returns `true` or `false`.

---

---
url: 'https://gramio.dev/api/contexts/classes/AcceptedGiftTypes.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / AcceptedGiftTypes

# Class: AcceptedGiftTypes

Defined in: contexts/index.d.ts:9

This object describes the types of gifts that can be gifted to a user or a chat.

[Documentation](https://core.telegram.org/bots/api/#acceptedgifttypes)

## Constructors

### Constructor

> **new AcceptedGiftTypes**(`payload`): `AcceptedGiftTypes`

Defined in: contexts/index.d.ts:11

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramAcceptedGiftTypes`](../../../../gramio/interfaces/TelegramAcceptedGiftTypes.md) |

#### Returns

`AcceptedGiftTypes`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramAcceptedGiftTypes`](../../../../gramio/interfaces/TelegramAcceptedGiftTypes.md) | contexts/index.d.ts:10 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:13

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### giftsFromChannels

#### Get Signature

> **get** **giftsFromChannels**(): `boolean`

Defined in: contexts/index.d.ts:33

True, if transfers of unique gifts from channels are accepted

##### Returns

`boolean`

***

### limitedGifts

#### Get Signature

> **get** **limitedGifts**(): `boolean`

Defined in: contexts/index.d.ts:21

True, if limited regular gifts are accepted

##### Returns

`boolean`

***

### premiumSubscription

#### Get Signature

> **get** **premiumSubscription**(): `boolean`

Defined in: contexts/index.d.ts:29

True, if a Telegram Premium subscription is accepted

##### Returns

`boolean`

***

### uniqueGifts

#### Get Signature

> **get** **uniqueGifts**(): `boolean`

Defined in: contexts/index.d.ts:25

True, if unique gifts or gifts that can be upgraded to unique for free are accepted

##### Returns

`boolean`

***

### unlimitedGifts

#### Get Signature

> **get** **unlimitedGifts**(): `boolean`

Defined in: contexts/index.d.ts:17

True, if unlimited regular gifts are accepted

##### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/contexts/classes/AnimationAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / AnimationAttachment

# Class: AnimationAttachment

Defined in: contexts/index.d.ts:341

This object represents an animation file
(GIF or H.264/MPEG-4 AVC video without sound).

## Extends

* [`FileAttachment`](FileAttachment.md)<[`TelegramAnimation`](../../../../gramio/interfaces/TelegramAnimation.md)>

## Constructors

### Constructor

> **new AnimationAttachment**(`payload`): `AnimationAttachment`

Defined in: contexts/index.d.ts:327

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramAnimation`](../../../../gramio/interfaces/TelegramAnimation.md) |

#### Returns

`AnimationAttachment`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`constructor`](FileAttachment.md#constructor)

## Properties

| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|  `attachmentType` | `public` | [`AttachmentType`](../type-aliases/AttachmentType.md) | Returns attachment's type (e.g. `'audio'`, `'photo'`) | [`FileAttachment`](FileAttachment.md).[`attachmentType`](FileAttachment.md#attachmenttype) | - | contexts/index.d.ts:342 |
|  `payload` | `protected` | [`TelegramAnimation`](../../../../gramio/interfaces/TelegramAnimation.md) | - | - | [`FileAttachment`](FileAttachment.md).[`payload`](FileAttachment.md#payload) | contexts/index.d.ts:324 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:314

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`[toStringTag]`](FileAttachment.md#tostringtag)

***

### duration

#### Get Signature

> **get** **duration**(): `number`

Defined in: contexts/index.d.ts:348

Duration of the video in seconds as defined by sender

##### Returns

`number`

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

Defined in: contexts/index.d.ts:329

Identifier for this file, which can be used to download or reuse the file

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileId`](FileAttachment.md#fileid)

***

### fileName

#### Get Signature

> **get** **fileName**(): `string`

Defined in: contexts/index.d.ts:352

Original animation filename as defined by sender

##### Returns

`string`

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

Defined in: contexts/index.d.ts:356

File size

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

Defined in: contexts/index.d.ts:334

Unique identifier for this file, which is supposed to be the same over
time and for different bots. Can't be used to download or reuse the file.

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileUniqueId`](FileAttachment.md#fileuniqueid)

***

### height

#### Get Signature

> **get** **height**(): `number`

Defined in: contexts/index.d.ts:346

Video height as defined by sender

##### Returns

`number`

***

### mimeType

#### Get Signature

> **get** **mimeType**(): `string`

Defined in: contexts/index.d.ts:354

MIME type of the file as defined by sender

##### Returns

`string`

***

### thumbnail

#### Get Signature

> **get** **thumbnail**(): [`PhotoSize`](PhotoSize.md)

Defined in: contexts/index.d.ts:350

Animation thumbnail as defined by sender

##### Returns

[`PhotoSize`](PhotoSize.md)

***

### width

#### Get Signature

> **get** **width**(): `number`

Defined in: contexts/index.d.ts:344

Video width as defined by sender

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/Attachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Attachment

# Class: Attachment

Defined in: contexts/index.d.ts:311

Simple attachment

## Extended by

* [`ContactAttachment`](ContactAttachment.md)
* [`FileAttachment`](FileAttachment.md)
* [`LocationAttachment`](LocationAttachment.md)
* [`PhotoAttachment`](PhotoAttachment.md)
* [`PollAttachment`](PollAttachment.md)
* [`StoryAttachment`](StoryAttachment.md)
* [`VenueAttachment`](VenueAttachment.md)

## Constructors

### Constructor

> **new Attachment**(): `Attachment`

#### Returns

`Attachment`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `attachmentType?` | [`AttachmentType`](../type-aliases/AttachmentType.md) | contexts/index.d.ts:312 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:314

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/AudioAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / AudioAttachment

# Class: AudioAttachment

Defined in: contexts/index.d.ts:363

This object represents an audio file to be treated as music by the Telegram
clients.

## Extends

* [`FileAttachment`](FileAttachment.md)<[`TelegramAudio`](../../../../gramio/interfaces/TelegramAudio.md)>

## Constructors

### Constructor

> **new AudioAttachment**(`payload`): `AudioAttachment`

Defined in: contexts/index.d.ts:327

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramAudio`](../../../../gramio/interfaces/TelegramAudio.md) |

#### Returns

`AudioAttachment`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`constructor`](FileAttachment.md#constructor)

## Properties

| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|  `attachmentType` | `public` | [`AttachmentType`](../type-aliases/AttachmentType.md) | Returns attachment's type (e.g. `'audio'`, `'photo'`) | [`FileAttachment`](FileAttachment.md).[`attachmentType`](FileAttachment.md#attachmenttype) | - | contexts/index.d.ts:364 |
|  `payload` | `protected` | [`TelegramAudio`](../../../../gramio/interfaces/TelegramAudio.md) | - | - | [`FileAttachment`](FileAttachment.md).[`payload`](FileAttachment.md#payload) | contexts/index.d.ts:324 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:314

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`[toStringTag]`](FileAttachment.md#tostringtag)

***

### duration

#### Get Signature

> **get** **duration**(): `number`

Defined in: contexts/index.d.ts:366

Duration of the audio in seconds as defined by sender

##### Returns

`number`

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

Defined in: contexts/index.d.ts:329

Identifier for this file, which can be used to download or reuse the file

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileId`](FileAttachment.md#fileid)

***

### fileName

#### Get Signature

> **get** **fileName**(): `string`

Defined in: contexts/index.d.ts:372

Original filename as defined by sender

##### Returns

`string`

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

Defined in: contexts/index.d.ts:376

File size

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

Defined in: contexts/index.d.ts:334

Unique identifier for this file, which is supposed to be the same over
time and for different bots. Can't be used to download or reuse the file.

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileUniqueId`](FileAttachment.md#fileuniqueid)

***

### mimeType

#### Get Signature

> **get** **mimeType**(): `string`

Defined in: contexts/index.d.ts:374

MIME type of the file as defined by sender

##### Returns

`string`

***

### performer

#### Get Signature

> **get** **performer**(): `string`

Defined in: contexts/index.d.ts:368

Performer of the audio as defined by sender or by audio tags

##### Returns

`string`

***

### thumbnail

#### Get Signature

> **get** **thumbnail**(): [`PhotoSize`](PhotoSize.md)

Defined in: contexts/index.d.ts:378

Thumbnail of the album cover to which the music file belongs

##### Returns

[`PhotoSize`](PhotoSize.md)

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:370

Title of the audio as defined by sender or by audio tags

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/BackgroundFillFreeformGradient.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BackgroundFillFreeformGradient

# Class: BackgroundFillFreeformGradient

Defined in: contexts/index.d.ts:951

The background is a freeform gradient that rotates after every message in the chat.

[Documentation](https://core.telegram.org/bots/api/#backgroundfillfreeformgradient)

## Constructors

### Constructor

> **new BackgroundFillFreeformGradient**(`payload`): `BackgroundFillFreeformGradient`

Defined in: contexts/index.d.ts:953

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBackgroundFillFreeformGradient`](../../../../gramio/interfaces/TelegramBackgroundFillFreeformGradient.md) |

#### Returns

`BackgroundFillFreeformGradient`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBackgroundFillFreeformGradient`](../../../../gramio/interfaces/TelegramBackgroundFillFreeformGradient.md) | contexts/index.d.ts:952 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:955

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### colors

#### Get Signature

> **get** **colors**(): `number`\[]

Defined in: contexts/index.d.ts:963

A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format

##### Returns

`number`\[]

***

### type

#### Get Signature

> **get** **type**(): `"freeform_gradient"`

Defined in: contexts/index.d.ts:959

Type of the background fill, always “freeform\_gradient”

##### Returns

`"freeform_gradient"`

---

---
url: 'https://gramio.dev/api/contexts/classes/BackgroundFillGradient.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BackgroundFillGradient

# Class: BackgroundFillGradient

Defined in: contexts/index.d.ts:971

The background is a gradient fill.

[Documentation](https://core.telegram.org/bots/api/#backgroundfillgradient)

## Constructors

### Constructor

> **new BackgroundFillGradient**(`payload`): `BackgroundFillGradient`

Defined in: contexts/index.d.ts:973

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBackgroundFillGradient`](../../../../gramio/interfaces/TelegramBackgroundFillGradient.md) |

#### Returns

`BackgroundFillGradient`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBackgroundFillGradient`](../../../../gramio/interfaces/TelegramBackgroundFillGradient.md) | contexts/index.d.ts:972 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:975

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### bottomColor

#### Get Signature

> **get** **bottomColor**(): `number`

Defined in: contexts/index.d.ts:987

Bottom color of the gradient in the RGB24 format

##### Returns

`number`

***

### rotationAngle

#### Get Signature

> **get** **rotationAngle**(): `number`

Defined in: contexts/index.d.ts:991

Clockwise rotation angle of the background fill in degrees; 0-359

##### Returns

`number`

***

### topColor

#### Get Signature

> **get** **topColor**(): `number`

Defined in: contexts/index.d.ts:983

Top color of the gradient in the RGB24 format

##### Returns

`number`

***

### type

#### Get Signature

> **get** **type**(): `"gradient"`

Defined in: contexts/index.d.ts:979

Type of the background fill, always “gradient”

##### Returns

`"gradient"`

---

---
url: 'https://gramio.dev/api/contexts/classes/BackgroundFillSolid.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BackgroundFillSolid

# Class: BackgroundFillSolid

Defined in: contexts/index.d.ts:999

The background is filled using the selected color.

[Documentation](https://core.telegram.org/bots/api/#backgroundfillsolid)

## Constructors

### Constructor

> **new BackgroundFillSolid**(`payload`): `BackgroundFillSolid`

Defined in: contexts/index.d.ts:1001

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBackgroundFillSolid`](../../../../gramio/interfaces/TelegramBackgroundFillSolid.md) |

#### Returns

`BackgroundFillSolid`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBackgroundFillSolid`](../../../../gramio/interfaces/TelegramBackgroundFillSolid.md) | contexts/index.d.ts:1000 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1003

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### color

#### Get Signature

> **get** **color**(): `number`

Defined in: contexts/index.d.ts:1011

The color of the background fill in the RGB24 format

##### Returns

`number`

***

### type

#### Get Signature

> **get** **type**(): `"solid"`

Defined in: contexts/index.d.ts:1007

Type of the background fill, always “solid”

##### Returns

`"solid"`

---

---
url: 'https://gramio.dev/api/contexts/classes/BackgroundTypeChatTheme.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BackgroundTypeChatTheme

# Class: BackgroundTypeChatTheme

Defined in: contexts/index.d.ts:1034

The background is taken directly from a built-in chat theme.

[Documentation](https://core.telegram.org/bots/api/#backgroundtypechattheme)

## Constructors

### Constructor

> **new BackgroundTypeChatTheme**(`payload`): `BackgroundTypeChatTheme`

Defined in: contexts/index.d.ts:1036

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBackgroundTypeChatTheme`](../../../../gramio/interfaces/TelegramBackgroundTypeChatTheme.md) |

#### Returns

`BackgroundTypeChatTheme`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBackgroundTypeChatTheme`](../../../../gramio/interfaces/TelegramBackgroundTypeChatTheme.md) | contexts/index.d.ts:1035 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1038

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### themeName

#### Get Signature

> **get** **themeName**(): `string`

Defined in: contexts/index.d.ts:1046

Name of the chat theme, which is usually an emoji

##### Returns

`string`

***

### type

#### Get Signature

> **get** **type**(): `"chat_theme"`

Defined in: contexts/index.d.ts:1042

Type of the background, always “chat\_theme”

##### Returns

`"chat_theme"`

---

---
url: 'https://gramio.dev/api/contexts/classes/BackgroundTypeFill.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BackgroundTypeFill

# Class: BackgroundTypeFill

Defined in: contexts/index.d.ts:1054

The background is automatically filled based on the selected colors.

[Documentation](https://core.telegram.org/bots/api/#backgroundtypefill)

## Constructors

### Constructor

> **new BackgroundTypeFill**(`payload`): `BackgroundTypeFill`

Defined in: contexts/index.d.ts:1056

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBackgroundTypeFill`](../../../../gramio/interfaces/TelegramBackgroundTypeFill.md) |

#### Returns

`BackgroundTypeFill`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBackgroundTypeFill`](../../../../gramio/interfaces/TelegramBackgroundTypeFill.md) | contexts/index.d.ts:1055 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1058

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### darkThemeDimming

#### Get Signature

> **get** **darkThemeDimming**(): `number`

Defined in: contexts/index.d.ts:1070

Dimming of the background in dark themes, as a percentage; 0-100

##### Returns

`number`

***

### fill

#### Get Signature

> **get** **fill**(): *typeof* [`BackgroundFillFreeformGradient`](BackgroundFillFreeformGradient.md) | *typeof* [`BackgroundFillGradient`](BackgroundFillGradient.md) | *typeof* [`BackgroundFillSolid`](BackgroundFillSolid.md)

Defined in: contexts/index.d.ts:1066

The background fill

##### Returns

*typeof* [`BackgroundFillFreeformGradient`](BackgroundFillFreeformGradient.md) | *typeof* [`BackgroundFillGradient`](BackgroundFillGradient.md) | *typeof* [`BackgroundFillSolid`](BackgroundFillSolid.md)

***

### type

#### Get Signature

> **get** **type**(): `"fill"`

Defined in: contexts/index.d.ts:1062

Type of the background, always “fill”

##### Returns

`"fill"`

---

---
url: 'https://gramio.dev/api/contexts/classes/BackgroundTypePattern.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BackgroundTypePattern

# Class: BackgroundTypePattern

Defined in: contexts/index.d.ts:1078

The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.

[Documentation](https://core.telegram.org/bots/api/#backgroundtypepattern)

## Constructors

### Constructor

> **new BackgroundTypePattern**(`payload`): `BackgroundTypePattern`

Defined in: contexts/index.d.ts:1080

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBackgroundTypePattern`](../../../../gramio/interfaces/TelegramBackgroundTypePattern.md) |

#### Returns

`BackgroundTypePattern`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBackgroundTypePattern`](../../../../gramio/interfaces/TelegramBackgroundTypePattern.md) | contexts/index.d.ts:1079 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1082

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:1090

Document with the pattern

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

***

### fill

#### Get Signature

> **get** **fill**(): *typeof* [`BackgroundFillFreeformGradient`](BackgroundFillFreeformGradient.md) | *typeof* [`BackgroundFillGradient`](BackgroundFillGradient.md) | *typeof* [`BackgroundFillSolid`](BackgroundFillSolid.md)

Defined in: contexts/index.d.ts:1094

The background fill that is combined with the pattern

##### Returns

*typeof* [`BackgroundFillFreeformGradient`](BackgroundFillFreeformGradient.md) | *typeof* [`BackgroundFillGradient`](BackgroundFillGradient.md) | *typeof* [`BackgroundFillSolid`](BackgroundFillSolid.md)

***

### intensity

#### Get Signature

> **get** **intensity**(): `number`

Defined in: contexts/index.d.ts:1098

Intensity of the pattern when it is shown above the filled background; 0-100

##### Returns

`number`

***

### isInverted

#### Get Signature

> **get** **isInverted**(): `true`

Defined in: contexts/index.d.ts:1102

*Optional*. *True*, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only

##### Returns

`true`

***

### isMoving

#### Get Signature

> **get** **isMoving**(): `true`

Defined in: contexts/index.d.ts:1106

*Optional*. *True*, if the background moves slightly when the device is tilted

##### Returns

`true`

***

### type

#### Get Signature

> **get** **type**(): `"pattern"`

Defined in: contexts/index.d.ts:1086

Type of the background, always “pattern”

##### Returns

`"pattern"`

---

---
url: 'https://gramio.dev/api/contexts/classes/BackgroundTypeWallpaper.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BackgroundTypeWallpaper

# Class: BackgroundTypeWallpaper

Defined in: contexts/index.d.ts:1114

The background is a wallpaper in the JPEG format.

[Documentation](https://core.telegram.org/bots/api/#backgroundtypewallpaper)

## Constructors

### Constructor

> **new BackgroundTypeWallpaper**(`payload`): `BackgroundTypeWallpaper`

Defined in: contexts/index.d.ts:1116

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBackgroundTypeWallpaper`](../../../../gramio/interfaces/TelegramBackgroundTypeWallpaper.md) |

#### Returns

`BackgroundTypeWallpaper`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBackgroundTypeWallpaper`](../../../../gramio/interfaces/TelegramBackgroundTypeWallpaper.md) | contexts/index.d.ts:1115 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1118

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### darkThemeDimming

#### Get Signature

> **get** **darkThemeDimming**(): `number`

Defined in: contexts/index.d.ts:1130

Dimming of the background in dark themes, as a percentage; 0-100

##### Returns

`number`

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:1126

Document with the wallpaper

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

***

### isBlurred

#### Get Signature

> **get** **isBlurred**(): `true`

Defined in: contexts/index.d.ts:1134

*Optional*. *True*, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12

##### Returns

`true`

***

### isMoving

#### Get Signature

> **get** **isMoving**(): `true`

Defined in: contexts/index.d.ts:1138

*Optional*. *True*, if the background moves slightly when the device is tilted

##### Returns

`true`

***

### type

#### Get Signature

> **get** **type**(): `"wallpaper"`

Defined in: contexts/index.d.ts:1122

Type of the background, always “wallpaper”

##### Returns

`"wallpaper"`

---

---
url: 'https://gramio.dev/api/keyboards/classes/BaseKeyboardConstructor.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / BaseKeyboardConstructor

# Class: BaseKeyboardConstructor\<T>

Defined in: keyboards/index.d.ts:44

Base-class for construct keyboard with useful helpers

## Extended by

* [`InlineKeyboard`](InlineKeyboard.md)
* [`Keyboard`](Keyboard.md)

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Constructors

### Constructor

> **new BaseKeyboardConstructor**<`T`>(`featureFlags?`): `BaseKeyboardConstructor`<`T`>

Defined in: keyboards/index.d.ts:48

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `featureFlags?` | [`KeyboardFeatureFlags`](../interfaces/KeyboardFeatureFlags.md) |

#### Returns

`BaseKeyboardConstructor`<`T`>

## Properties

| Property | Modifier | Type | Defined in |
| ------ | ------ | ------ | ------ |
|  `currentRow` | `protected` | `T`\[] | keyboards/index.d.ts:46 |
|  `featureFlags` | `protected` | [`KeyboardFeatureFlags`](../interfaces/KeyboardFeatureFlags.md) | keyboards/index.d.ts:47 |
|  `rows` | `protected` | `T`\[]\[] | keyboards/index.d.ts:45 |

## Accessors

### keyboard

#### Get Signature

> **get** `protected` **keyboard**(): `T`\[]\[]

Defined in: keyboards/index.d.ts:52

##### Returns

`T`\[]\[]

## Methods

### add()

> **add**(...`buttons`): `this`

Defined in: keyboards/index.d.ts:127

Allows you to add multiple buttons in raw format.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`buttons` | `T`\[] |

#### Returns

`this`

#### Example

```ts
const labels = ["some", "buttons"];

new InlineKeyboard()
    .add({ text: "raw button", callback_data: "payload" })
    .add(InlineKeyboard.text("raw button by InlineKeyboard.text", "payload"))
    .add(...labels.map((x) => InlineKeyboard.text(x, `${x}payload`)));
```

***

### addIf()

> **addIf**(`condition`, ...`buttons`): `this`

Defined in: keyboards/index.d.ts:147

Allows you to dynamically substitute buttons depending on something

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `condition` | `boolean` | (`options`) => `boolean` |
| ...`buttons` | `T`\[] |

#### Returns

`this`

#### Example

```ts
const labels = ["some", "buttons"];
const isAdmin = true;

new InlineKeyboard()
    .addIf(1 === 2, { text: "raw button", callback_data: "payload" })
    .addIf(
        isAdmin,
        InlineKeyboard.text("raw button by InlineKeyboard.text", "payload")
    )
    .addIf(
        ({ index, rowIndex }) => rowIndex === index,
        ...labels.map((x) => InlineKeyboard.text(x, `${x}payload`))
    );
```

***

### columns()

> **columns**(`length?`): `this`

Defined in: keyboards/index.d.ts:75

Allows you to limit the number of columns in the keyboard.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `length?` | `number` |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .columns(1)
    .text("first row", "payload")
    .text("second row", "payload");
    .text("third row", "payload");
```

***

### filter()

> **filter**(`fn?`): `this`

Defined in: keyboards/index.d.ts:99

A handler that helps filter keyboard buttons

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `fn?` | [`ButtonsIterator`](../type-aliases/ButtonsIterator.md)<`T`> |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .filter(({ button }) => button.callback_data !== "hidden")
    .text("button", "pass")
    .text("button", "hidden")
    .text("button", "pass");
```

***

### matrix()

> **matrix**(`rows`, `columns`, `fn`): `this`

Defined in: keyboards/index.d.ts:167

Allows you to create a button matrix.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rows` | `number` |
| `columns` | `number` |
| `fn` | [`CreateButtonIterator`](../type-aliases/CreateButtonIterator.md)<`T`> |

#### Returns

`this`

#### Example

```ts
import { randomInt } from "node:crypto";

const bomb = [randomInt(0, 9), randomInt(0, 9)] as const;

new InlineKeyboard().matrix(10, 10, ({ rowIndex, index }) =>
   InlineKeyboard.text(
       rowIndex === bomb[0] && index === bomb[1] ? "💣" : "ㅤ",
       "payload"
   )
);
```

***

### pattern()

> **pattern**(`pattern?`): `this`

Defined in: keyboards/index.d.ts:114

An array with the number of columns per row. Allows you to set a "template"

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `pattern?` | `number`\[] |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .pattern([1, 3, 2])
    .text("1", "payload")
    .text("2", "payload")
    .text("2", "payload")
    .text("2", "payload")
    .text("3", "payload")
    .text("3", "payload");
```

***

### resetHelpers()

> **resetHelpers**(): `this`

Defined in: keyboards/index.d.ts:168

#### Returns

`this`

***

### row()

> **row**(): `this`

Defined in: keyboards/index.d.ts:63

Adds a `line break`. Call this method to make sure that the next added buttons will be on a new row.

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .text("first row", "payload")
    .row()
    .text("second row", "payload");
```

***

### wrap()

> **wrap**(`fn?`): `this`

Defined in: keyboards/index.d.ts:87

A custom handler that controls row wrapping.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `fn?` | [`ButtonsIterator`](../type-aliases/ButtonsIterator.md)<`T`> |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .wrap(({ button }) => button.callback_data === "2")
    .text("first row", "1")
    .text("first row", "1");
    .text("second row", "2");
```

---

---
url: 'https://gramio.dev/api/contexts/classes/Birthdate.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Birthdate

# Class: Birthdate

Defined in: contexts/index.d.ts:1163

Describes the birthdate of a user.

[Documentation](https://core.telegram.org/bots/api/#birthdate)

## Constructors

### Constructor

> **new Birthdate**(`payload`): `Birthdate`

Defined in: contexts/index.d.ts:1165

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBirthdate`](../../../../gramio/interfaces/TelegramBirthdate.md) |

#### Returns

`Birthdate`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBirthdate`](../../../../gramio/interfaces/TelegramBirthdate.md) | contexts/index.d.ts:1164 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1167

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### day

#### Get Signature

> **get** **day**(): `number`

Defined in: contexts/index.d.ts:1171

Day of the user's birth; 1-31

##### Returns

`number`

***

### month

#### Get Signature

> **get** **month**(): `number`

Defined in: contexts/index.d.ts:1175

Month of the user's birth; 1-12

##### Returns

`number`

***

### year

#### Get Signature

> **get** **year**(): `number`

Defined in: contexts/index.d.ts:1179

*Optional*. Year of the user's birth

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/BoostAddedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BoostAddedContext

# Class: BoostAddedContext\<Bot>

Defined in: contexts/index.d.ts:5297

This object represents a service message about a forum topic closed in the chat. Currently holds no information.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`BoostAddedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `BoostAddedContext`<`Bot`>, `BoostAddedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new BoostAddedContext**<`Bot`>(`options`): `BoostAddedContext`<`Bot`>

Defined in: contexts/index.d.ts:5301

Create new BoostAddedContext

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `BoostAddedContextOptions`<`Bot`> |

#### Returns

`BoostAddedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new BoostAddedContext**(...`args`): `BoostAddedContext`

Defined in: contexts/index.d.ts:5297

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`BoostAddedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5299 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### boostCount

#### Get Signature

> **get** **boostCount**(): `number`

Defined in: contexts/index.d.ts:5303

Number of boosts added by the user

##### Returns

`number`

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `BoostAddedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `BoostAddedContextOptions` |

#### Returns

`BoostAddedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<BoostAddedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<BoostAddedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<BoostAddedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<BoostAddedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<BoostAddedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<BoostAddedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<BoostAddedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<BoostAddedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<BoostAddedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<BoostAddedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<BoostAddedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<BoostAddedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/gramio/classes/Bot.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / Bot

# Class: Bot\<Errors, Derives, Macros>

Defined in: gramio/index.d.ts:874

Bot instance

## Example

```ts
import { Bot } from "gramio";

const bot = new Bot("") // put you token here
    .command("start", (context) => context.send("Hi!"))
    .onStart(console.log);

bot.start();
```

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Errors` *extends* [`ErrorDefinitions`](../type-aliases/ErrorDefinitions.md) | `object` |
| `Derives` *extends* [`DeriveDefinitions`](../type-aliases/DeriveDefinitions.md) | [`DeriveDefinitions`](../type-aliases/DeriveDefinitions.md) |
| `Macros` *extends* [`MacroDefinitions`](../../../composer/type-aliases/MacroDefinitions.md) | `object` |

## Constructors

### Constructor

> **new Bot**<`Errors`, `Derives`, `Macros`>(`token`, `options?`): `Bot`<`Errors`, `Derives`, `Macros`>

Defined in: gramio/index.d.ts:911

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `token` | `string` |
| `options?` | `Omit`<[`BotOptions`](../interfaces/BotOptions.md), `"token"` | `"api"`> & `object` |

#### Returns

`Bot`<`Errors`, `Derives`, `Macros`>

### Constructor

> **new Bot**<`Errors`, `Derives`, `Macros`>(`options`): `Bot`<`Errors`, `Derives`, `Macros`>

Defined in: gramio/index.d.ts:914

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `Omit`<[`BotOptions`](../interfaces/BotOptions.md), `"api"`> & `object` |

#### Returns

`Bot`<`Errors`, `Derives`, `Macros`>

## Properties

| Property | Modifier | Type | Description | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  ~~`_`~~ | `public` | `object` | **Deprecated** use `~` instead | gramio/index.d.ts:876 |
| `_.derives` | `public` | `Derives` | **Deprecated** @internal. Remap generic | gramio/index.d.ts:878 |
|  ~~`__Derives`~~ | `public` | `Derives` | **Deprecated** use `~.derives` instead @internal. Remap generic | gramio/index.d.ts:881 |
|  `~` | `public` | `object` | - | gramio/index.d.ts:882 |
| `~.derives` | `public` | `Derives` | **Deprecated** @internal. Remap generic | gramio/index.d.ts:884 |
|  `api` | `readonly` | [`SuppressedAPIMethods`](../type-aliases/SuppressedAPIMethods.md) | Send API Request to Telegram Bot API **Example** `const response = await bot.api.sendMessage({ chat_id: "@gramio_forum", text: "some text", });` [Documentation](https://gramio.dev/bot-api.html) | gramio/index.d.ts:903 |
|  `info` | `public` | [`TelegramUser`](../interfaces/TelegramUser.md) | Bot data (filled in when calling bot.init/bot.start) | gramio/index.d.ts:889 |
|  `options` | `readonly` | [`BotOptions`](../interfaces/BotOptions.md) | Options provided to instance | gramio/index.d.ts:887 |
|  `updates` | `public` | [`Updates`](Updates.md) | This instance handle updates | gramio/index.d.ts:909 |

## Methods

### callbackQuery()

> **callbackQuery**<`Trigger`, `TOptions`>(`trigger`, `handler`, `options?`): `this`

Defined in: gramio/index.d.ts:1214

Register handler to `callback_query` event

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Trigger` *extends* `string` | `RegExp` | [`CallbackData`](../../../callback-data/classes/CallbackData.md)<`Record`<`never`, `never`>, `Record`<`never`, `never`>> | - |
| `TOptions` *extends* [`HandlerOptions`](../../../composer/type-aliases/HandlerOptions.md)<[`CallbackQueryShorthandContext`](../type-aliases/CallbackQueryShorthandContext.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `Trigger`>, `Macros`> | `object` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `trigger` | `Trigger` |
| `handler` | (`context`) => `unknown` |
| `options?` | `TOptions` |

#### Returns

`this`

#### Example

```ts
const someData = new CallbackData("example").number("id");

new Bot()
    .command("start", (context) =>
        context.send("some", {
            reply_markup: new InlineKeyboard().text(
                "example",
                someData.pack({
                    id: 1,
                })
            ),
        })
    )
    .callbackQuery(someData, (context) => {
        context.queryData; // is type-safe
    });
```

***

### chosenInlineResult()

> **chosenInlineResult**<`Ctx`, `TOptions`>(`trigger`, `handler`, `options?`): `this`

Defined in: gramio/index.d.ts:1216

Register handler to `chosen_inline_result` update

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Ctx` | [`ContextType`](../../../contexts/type-aliases/ContextType.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `"chosen_inline_result"`> |
| `TOptions` *extends* [`HandlerOptions`](../../../composer/type-aliases/HandlerOptions.md)<`Ctx`, `Macros`> | `object` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `trigger` | `string` | `RegExp` | (`context`) => `boolean` |
| `handler` | (`context`) => `unknown` |
| `options?` | `TOptions` |

#### Returns

`this`

***

### command()

> **command**<`TOptions`>(`command`, `handler`, `options?`): `this`

Defined in: gramio/index.d.ts:1284

Register handler to `message` and `business_message` event when entities contains a command

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `TOptions` *extends* [`HandlerOptions`](../../../composer/type-aliases/HandlerOptions.md)<[`ContextType`](../../../contexts/type-aliases/ContextType.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `"message"`>, `Macros`> | `object` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `command` | `MaybeArray`<`string`> |
| `handler` | (`context`) => `unknown` |
| `options?` | `TOptions` |

#### Returns

`this`

#### Example

```ts
new Bot().command("start", async (context) => {
    return context.send(`You message is /start ${context.args}`);
});
```

***

### decorate()

#### Call Signature

> **decorate**<`Value`>(`value`): `Bot`<`Errors`, `Derives` & `object`, `Macros`>

Defined in: gramio/index.d.ts:1006

##### Type Parameters

| Type Parameter |
| ------ |
| `Value` *extends* `Record`<`string`, `any`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `Value` |

##### Returns

`Bot`<`Errors`, `Derives` & `object`, `Macros`>

#### Call Signature

> **decorate**<`Name`, `Value`>(`name`, `value`): `Bot`<`Errors`, `Derives` & `object`, `Macros`>

Defined in: gramio/index.d.ts:1011

##### Type Parameters

| Type Parameter |
| ------ |
| `Name` *extends* `string` |
| `Value` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `Name` |
| `value` | `Value` |

##### Returns

`Bot`<`Errors`, `Derives` & `object`, `Macros`>

***

### derive()

#### Call Signature

> **derive**<`Handler`>(`handler`): `Bot`<`Errors`, `Derives` & `object`, `Macros`>

Defined in: gramio/index.d.ts:1000

Derive some data to handlers

##### Type Parameters

| Type Parameter |
| ------ |
| `Handler` *extends* [`Derive`](../namespaces/Hooks/type-aliases/Derive.md)<[`Context`](../../../contexts/classes/Context.md)<`Bot`<`Errors`, `Derives`, `Macros`>> & `Derives`\[`"global"`]> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | `Handler` |

##### Returns

`Bot`<`Errors`, `Derives` & `object`, `Macros`>

##### Example

```ts
new Bot("token").derive((context) => {
		return {
			superSend: () => context.send("Derived method")
		}
})
```

#### Call Signature

> **derive**<`Update`, `Handler`>(`updateName`, `handler`): `Bot`<`Errors`, `Derives` & `{ [K in UpdateName]: Awaited<ReturnType<Handler>> }`, `Macros`>

Defined in: gramio/index.d.ts:1003

Derive some data to handlers

##### Type Parameters

| Type Parameter |
| ------ |
| `Update` *extends* [`UpdateName`](../../../contexts/type-aliases/UpdateName.md) |
| `Handler` *extends* [`Derive`](../namespaces/Hooks/type-aliases/Derive.md)<`InstanceType`<[`ContextsMapping`](../../../contexts/type-aliases/ContextsMapping.md)<`Bot`<`Errors`, `Derives`, `Macros`>>\[`Update`]> & `Derives`\[`"global"`] & `Derives`\[`Update`]> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `updateName` | `MaybeArray`<`Update`> |
| `handler` | `Handler` |

##### Returns

`Bot`<`Errors`, `Derives` & `{ [K in UpdateName]: Awaited<ReturnType<Handler>> }`, `Macros`>

##### Example

```ts
new Bot("token").derive((context) => {
		return {
			superSend: () => context.send("Derived method")
		}
})
```

***

### downloadFile()

#### Call Signature

> **downloadFile**(`attachment`): `Promise`<`ArrayBuffer`>

Defined in: gramio/index.d.ts:937

Download file

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `attachment` | `string` | [`Attachment`](../../../contexts/classes/Attachment.md) | { `file_id`: `string`; } |

##### Returns

`Promise`<`ArrayBuffer`>

##### Example

```ts
bot.on("message", async (context) => {
    if (!context.document) return;
    // download to ./file-name
    await context.download(context.document.fileName || "file-name");
    // get ArrayBuffer
    const buffer = await context.download();

    return context.send("Thank you!");
});
```

[Documentation](https://gramio.dev/files/download.html)

#### Call Signature

> **downloadFile**(`attachment`, `path`): `Promise`<`string`>

Defined in: gramio/index.d.ts:940

Download file

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `attachment` | `string` | [`Attachment`](../../../contexts/classes/Attachment.md) | { `file_id`: `string`; } |
| `path` | `string` |

##### Returns

`Promise`<`string`>

##### Example

```ts
bot.on("message", async (context) => {
    if (!context.document) return;
    // download to ./file-name
    await context.download(context.document.fileName || "file-name");
    // get ArrayBuffer
    const buffer = await context.download();

    return context.send("Thank you!");
});
```

[Documentation](https://gramio.dev/files/download.html)

***

### error()

> **error**<`Name`, `NewError`>(`kind`, `error`): `Bot`<`Errors` & `{ [name in string]: InstanceType<NewError> }`, `Derives`, `Macros`>

Defined in: gramio/index.d.ts:973

Register custom class-error for type-safe catch in `onError` hook

#### Type Parameters

| Type Parameter |
| ------ |
| `Name` *extends* `string` |
| `NewError` *extends* {(...`args`): `any`; `prototype`: `Error`; } |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `kind` | `Name` |
| `error` | `NewError` |

#### Returns

`Bot`<`Errors` & `{ [name in string]: InstanceType<NewError> }`, `Derives`, `Macros`>

#### Example

```ts
export class NoRights extends Error {
    needRole: "admin" | "moderator";

    constructor(role: "admin" | "moderator") {
        super();
        this.needRole = role;
    }
}

const bot = new Bot(process.env.TOKEN!)
    .error("NO_RIGHTS", NoRights)
    .onError(({ context, kind, error }) => {
        if (context.is("message") && kind === "NO_RIGHTS")
            return context.send(
                format`You don't have enough rights! You need to have an «${bold(
                    error.needRole
                )}» role.`
            );
    });

bot.updates.on("message", (context) => {
    if (context.text === "bun") throw new NoRights("admin");
});
```

***

### extend()

#### Call Signature

> **extend**<`UExposed`, `UDerives`>(`composer`): `Bot`<`Errors`, `Derives` & `object` & `UDerives`, `Macros`>

Defined in: gramio/index.d.ts:1176

Extend [Plugin](Plugin.md) logic and types

##### Type Parameters

| Type Parameter |
| ------ |
| `UExposed` *extends* `object` |
| `UDerives` *extends* `Record`<`string`, `object`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `composer` | [`EventComposer`](../../../composer/interfaces/EventComposer.md)<`any`, `any`, `any`, `any`, `UExposed`, `UDerives`, `any`, `any`> |

##### Returns

`Bot`<`Errors`, `Derives` & `object` & `UDerives`, `Macros`>

##### Example

```ts
import { Plugin, Bot } from "gramio";

export class PluginError extends Error {
    wow: "type" | "safe" = "type";
}

const plugin = new Plugin("gramio-example")
    .error("PLUGIN", PluginError)
    .derive(() => {
        return {
            some: ["derived", "props"] as const,
        };
    });

const bot = new Bot(process.env.TOKEN!)
    .extend(plugin)
    .onError(({ context, kind, error }) => {
        if (context.is("message") && kind === "PLUGIN") {
            console.log(error.wow);
        }
    })
    .use((context) => {
        console.log(context.some);
    });
```

#### Call Signature

> **extend**<`NewPlugin`>(`plugin`): `Bot`<`Errors` & `NewPlugin`\[`"_"`]\[`"Errors"`], `Derives` & `NewPlugin`\[`"_"`]\[`"Derives"`], `Macros` & `NewPlugin`\[`"_"`]\[`"Macros"`]>

Defined in: gramio/index.d.ts:1179

Extend [Plugin](Plugin.md) logic and types

##### Type Parameters

| Type Parameter |
| ------ |
| `NewPlugin` *extends* [`AnyPlugin`](../type-aliases/AnyPlugin.md) |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `plugin` | [`MaybePromise`](../type-aliases/MaybePromise.md)<`NewPlugin`> |

##### Returns

`Bot`<`Errors` & `NewPlugin`\[`"_"`]\[`"Errors"`], `Derives` & `NewPlugin`\[`"_"`]\[`"Derives"`], `Macros` & `NewPlugin`\[`"_"`]\[`"Macros"`]>

##### Example

```ts
import { Plugin, Bot } from "gramio";

export class PluginError extends Error {
    wow: "type" | "safe" = "type";
}

const plugin = new Plugin("gramio-example")
    .error("PLUGIN", PluginError)
    .derive(() => {
        return {
            some: ["derived", "props"] as const,
        };
    });

const bot = new Bot(process.env.TOKEN!)
    .extend(plugin)
    .onError(({ context, kind, error }) => {
        if (context.is("message") && kind === "PLUGIN") {
            console.log(error.wow);
        }
    })
    .use((context) => {
        console.log(context.some);
    });
```

***

### group()

> **group**(`grouped`): `Bot`<`Errors`, `Derives`, `Macros`>

Defined in: gramio/index.d.ts:1303

Currently not isolated!!!

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `grouped` | (`bot`) => [`AnyBot`](../type-aliases/AnyBot.md) |

#### Returns

`Bot`<`Errors`, `Derives`, `Macros`>

***

### hears()

> **hears**<`Ctx`, `Trigger`, `TOptions`>(`trigger`, `handler`, `options?`): `this`

Defined in: gramio/index.d.ts:1271

Register handler to `message` and `business_message` event

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Ctx` | [`ContextType`](../../../contexts/type-aliases/ContextType.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `"message"`> |
| `Trigger` *extends* `RegExp` | `MaybeArray`<`string`> | (`context`) => `boolean` | `RegExp` | `MaybeArray`<`string`> | (`context`) => `boolean` |
| `TOptions` *extends* [`HandlerOptions`](../../../composer/type-aliases/HandlerOptions.md)<`Ctx`, `Macros`> | `object` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `trigger` | `Trigger` |
| `handler` | (`context`) => `unknown` |
| `options?` | `TOptions` |

#### Returns

`this`

#### Example

```ts
new Bot().hears(/regular expression with (.*)/i, async (context) => {
    if (context.args) await context.send(`Params ${context.args[1]}`);
});
```

***

### init()

> **init**(): `Promise`<`void`>

Defined in: gramio/index.d.ts:1307

Init bot. Call it manually only if you doesn't use [Bot.start](#start)

#### Returns

`Promise`<`void`>

***

### inlineQuery()

> **inlineQuery**<`Ctx`>(`trigger`, `handler`, `options?`): `this`

Defined in: gramio/index.d.ts:1254

Register handler to `inline_query` update

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Ctx` | [`ContextType`](../../../contexts/type-aliases/ContextType.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `"inline_query"`> |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `trigger` | `string` | `RegExp` | (`context`) => `boolean` |
| `handler` | (`context`) => `unknown` |
| `options?` | `object` & { \[K in string | number | symbol]?: WithCtx\<MacroOptionType\<Macros\[K]>, Ctx> } & `object` |

#### Returns

`this`

#### Example

```ts
new Bot().inlineQuery(
    /regular expression with (.*)/i,
    async (context) => {
        if (context.args) {
            await context.answer(
                [
                    InlineQueryResult.article(
                        "id-1",
                        context.args[1],
                        InputMessageContent.text("some"),
                        {
                            reply_markup: new InlineKeyboard().text(
                                "some",
                                "callback-data"
                            ),
                        }
                    ),
                ],
                {
                    cache_time: 0,
                }
            );
        }
    },
    {
        onResult: (context) => context.editText("Message edited!"),
    }
);
```

***

### macro()

#### Call Signature

> **macro**<`Name`, `TDef`>(`name`, `definition`): `Bot`<`Errors`, `Derives`, `Macros` & `Record`<`Name`, `TDef`>>

Defined in: gramio/index.d.ts:1035

Register a single named macro definition

##### Type Parameters

| Type Parameter |
| ------ |
| `Name` *extends* `string` |
| `TDef` *extends* [`MacroDef`](../../../composer/type-aliases/MacroDef.md)<`any`, `any`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `Name` |
| `definition` | `TDef` |

##### Returns

`Bot`<`Errors`, `Derives`, `Macros` & `Record`<`Name`, `TDef`>>

##### Example

```ts
import { Bot, type MacroDef } from "gramio";

const onlyAdmin: MacroDef = {
  preHandler: (ctx, next) => {
    if (ctx.from?.id !== ADMIN_ID) return;
    return next();
  },
};

const bot = new Bot(process.env.TOKEN!)
  .macro("onlyAdmin", onlyAdmin)
  .command("ban", handler, { onlyAdmin: true });
```

#### Call Signature

> **macro**<`TDefs`>(`definitions`): `Bot`<`Errors`, `Derives`, `Macros` & `TDefs`>

Defined in: gramio/index.d.ts:1037

Register multiple macro definitions at once

##### Type Parameters

| Type Parameter |
| ------ |
| `TDefs` *extends* `Record`<`string`, [`MacroDef`](../../../composer/type-aliases/MacroDef.md)<`any`, `any`>> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `definitions` | `TDefs` |

##### Returns

`Bot`<`Errors`, `Derives`, `Macros` & `TDefs`>

***

### on()

#### Call Signature

> **on**<`Narrowing`>(`filter`, `handler`): `this`

Defined in: gramio/index.d.ts:1134

Register handler with a type-narrowing filter (auto-discovers matching events)

##### Type Parameters

| Type Parameter |
| ------ |
| `Narrowing` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `filter` | (`ctx`) => `ctx is Narrowing` |
| `handler` | [`Handler`](../type-aliases/Handler.md)<`InstanceType`<[`ContextsMapping`](../../../contexts/type-aliases/ContextsMapping.md)<`Bot`<`Errors`, `Derives`, `Macros`>>\[`CompatibleUpdates`<`Bot`<`Errors`, `Derives`, `Macros`>, `Narrowing`>]> & `Derives`\[`"global"`] & `Derives`\[`CompatibleUpdates`<`Bot`<`Errors`, `Derives`, `Macros`>, `Narrowing`>] & `Narrowing`> |

##### Returns

`this`

#### Call Signature

> **on**(`filter`, `handler`): `this`

Defined in: gramio/index.d.ts:1136

Register handler with a boolean filter (all updates)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `filter` | (`ctx`) => `boolean` |
| `handler` | [`Handler`](../type-aliases/Handler.md)<[`Context`](../../../contexts/classes/Context.md)<`Bot`<`Errors`, `Derives`, `Macros`>> & `Derives`\[`"global"`]> |

##### Returns

`this`

#### Call Signature

> **on**<`T`, `Narrowing`>(`updateName`, `filter`, `handler`): `this`

Defined in: gramio/index.d.ts:1138

Register handler to one or many Updates with a type-narrowing filter

##### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../../../contexts/type-aliases/UpdateName.md) |
| `Narrowing` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `updateName` | `MaybeArray`<`T`> |
| `filter` | (`ctx`) => `ctx is Narrowing` |
| `handler` | [`Handler`](../type-aliases/Handler.md)<`InstanceType`<[`ContextsMapping`](../../../contexts/type-aliases/ContextsMapping.md)<`Bot`<`Errors`, `Derives`, `Macros`>>\[`T`]> & `Derives`\[`"global"`] & `Derives`\[`T`] & `Narrowing`> |

##### Returns

`this`

#### Call Signature

> **on**<`T`>(`updateName`, `filter`, `handler`): `this`

Defined in: gramio/index.d.ts:1140

Register handler to one or many Updates with a boolean filter (no type narrowing)

##### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../../../contexts/type-aliases/UpdateName.md) |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `updateName` | `MaybeArray`<`T`> |
| `filter` | (`ctx`) => `boolean` |
| `handler` | [`Handler`](../type-aliases/Handler.md)<[`ContextType`](../../../contexts/type-aliases/ContextType.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `T`>> |

##### Returns

`this`

#### Call Signature

> **on**<`T`>(`updateName`, `handler`): `this`

Defined in: gramio/index.d.ts:1142

Register handler to one or many Updates

##### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../../../contexts/type-aliases/UpdateName.md) |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `updateName` | `MaybeArray`<`T`> |
| `handler` | [`Handler`](../type-aliases/Handler.md)<[`ContextType`](../../../contexts/type-aliases/ContextType.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `T`>> |

##### Returns

`this`

***

### onApiCall()

#### Call Signature

> **onApiCall**<`Methods`, `Handler`>(`methods`, `handler`): `this`

Defined in: gramio/index.d.ts:1131

This hook wraps the entire API call, enabling tracing/instrumentation.

##### Type Parameters

| Type Parameter |
| ------ |
| `Methods` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |
| `Handler` *extends* [`OnApiCall`](../namespaces/Hooks/type-aliases/OnApiCall.md)<`Methods`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `methods` | `MaybeArray`<`Methods`> |
| `handler` | `Handler` |

##### Returns

`this`

##### Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).onApiCall(async (context, next) => {
    console.log(`Calling ${context.method}`);
    const result = await next();
    console.log(`${context.method} completed`);
    return result;
});
```

#### Call Signature

> **onApiCall**(`handler`): `this`

Defined in: gramio/index.d.ts:1132

This hook wraps the entire API call, enabling tracing/instrumentation.

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`OnApiCall`](../namespaces/Hooks/type-aliases/OnApiCall.md) |

##### Returns

`this`

##### Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).onApiCall(async (context, next) => {
    console.log(`Calling ${context.method}`);
    const result = await next();
    console.log(`${context.method} completed`);
    return result;
});
```

***

### onError()

#### Call Signature

> **onError**<`T`>(`updateName`, `handler`): `this`

Defined in: gramio/index.d.ts:986

Set error handler.

##### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../../../contexts/type-aliases/UpdateName.md) |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `updateName` | `MaybeArray`<`T`> |
| `handler` | [`OnError`](../namespaces/Hooks/type-aliases/OnError.md)<`Errors`, [`ContextType`](../../../contexts/type-aliases/ContextType.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `T`>> |

##### Returns

`this`

##### Example

```ts
bot.onError("message", ({ context, kind, error }) => {
	return context.send(`${kind}: ${error.message}`);
})
```

#### Call Signature

> **onError**(`handler`): `this`

Defined in: gramio/index.d.ts:987

Set error handler.

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`OnError`](../namespaces/Hooks/type-aliases/OnError.md)<`Errors`, [`Context`](../../../contexts/classes/Context.md)<`Bot`<`Errors`, `Derives`, `Macros`>> & `Derives`\[`"global"`]> |

##### Returns

`this`

##### Example

```ts
bot.onError("message", ({ context, kind, error }) => {
	return context.send(`${kind}: ${error.message}`);
})
```

***

### onResponse()

#### Call Signature

> **onResponse**<`Methods`, `Handler`>(`methods`, `handler`): `this`

Defined in: gramio/index.d.ts:1107

This hook called when API return successful response

[Documentation](https://gramio.dev/hooks/on-response.html)

##### Type Parameters

| Type Parameter |
| ------ |
| `Methods` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |
| `Handler` *extends* [`OnResponse`](../namespaces/Hooks/type-aliases/OnResponse.md)<`Methods`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `methods` | `MaybeArray`<`Methods`> |
| `handler` | `Handler` |

##### Returns

`this`

#### Call Signature

> **onResponse**(`handler`): `this`

Defined in: gramio/index.d.ts:1108

This hook called when API return successful response

[Documentation](https://gramio.dev/hooks/on-response.html)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`OnResponse`](../namespaces/Hooks/type-aliases/OnResponse.md) |

##### Returns

`this`

***

### onResponseError()

#### Call Signature

> **onResponseError**<`Methods`, `Handler`>(`methods`, `handler`): `this`

Defined in: gramio/index.d.ts:1114

This hook called when API return an error

[Documentation](https://gramio.dev/hooks/on-response-error.html)

##### Type Parameters

| Type Parameter |
| ------ |
| `Methods` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |
| `Handler` *extends* [`OnResponseError`](../namespaces/Hooks/type-aliases/OnResponseError.md)<`Methods`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `methods` | `MaybeArray`<`Methods`> |
| `handler` | `Handler` |

##### Returns

`this`

#### Call Signature

> **onResponseError**(`handler`): `this`

Defined in: gramio/index.d.ts:1115

This hook called when API return an error

[Documentation](https://gramio.dev/hooks/on-response-error.html)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`OnResponseError`](../namespaces/Hooks/type-aliases/OnResponseError.md) |

##### Returns

`this`

***

### onStart()

> **onStart**(`handler`): `this`

Defined in: gramio/index.d.ts:1058

This hook called when the bot is `started`.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`OnStart`](../namespaces/Hooks/type-aliases/OnStart.md) |

#### Returns

`this`

#### Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).onStart(
    ({ plugins, info, updatesFrom }) => {
        console.log(`plugin list - ${plugins.join(", ")}`);
        console.log(`bot username is @${info.username}`);
		   console.log(`updates from ${updatesFrom}`);
    }
);

bot.start();
```

[Documentation](https://gramio.dev/hooks/on-start.html)

***

### onStop()

> **onStop**(`handler`): `this`

Defined in: gramio/index.d.ts:1079

This hook called when the bot stops.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`OnStop`](../namespaces/Hooks/type-aliases/OnStop.md) |

#### Returns

`this`

#### Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).onStop(
    ({ plugins, info, updatesFrom }) => {
        console.log(`plugin list - ${plugins.join(", ")}`);
        console.log(`bot username is @${info.username}`);
    }
);

bot.start();
bot.stop();
```

[Documentation](https://gramio.dev/hooks/on-stop.html)

***

### preRequest()

#### Call Signature

> **preRequest**<`Methods`, `Handler`>(`methods`, `handler`): `this`

Defined in: gramio/index.d.ts:1100

This hook called before sending a request to Telegram Bot API (allows us to impact the sent parameters).

##### Type Parameters

| Type Parameter |
| ------ |
| `Methods` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |
| `Handler` *extends* [`PreRequest`](../namespaces/Hooks/type-aliases/PreRequest.md)<`Methods`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `methods` | `MaybeArray`<`Methods`> |
| `handler` | `Handler` |

##### Returns

`this`

##### Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).preRequest((context) => {
    if (context.method === "sendMessage") {
        context.params.text = "mutate params";
    }

    return context;
});

bot.start();
```

[Documentation](https://gramio.dev/hooks/pre-request.html)

#### Call Signature

> **preRequest**(`handler`): `this`

Defined in: gramio/index.d.ts:1101

This hook called before sending a request to Telegram Bot API (allows us to impact the sent parameters).

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`PreRequest`](../namespaces/Hooks/type-aliases/PreRequest.md) |

##### Returns

`this`

##### Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).preRequest((context) => {
    if (context.method === "sendMessage") {
        context.params.text = "mutate params";
    }

    return context;
});

bot.start();
```

[Documentation](https://gramio.dev/hooks/pre-request.html)

***

### reaction()

> **reaction**<`TOptions`>(`trigger`, `handler`, `options?`): `this`

Defined in: gramio/index.d.ts:1190

Register handler to reaction (`message_reaction` update)

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `TOptions` *extends* [`HandlerOptions`](../../../composer/type-aliases/HandlerOptions.md)<[`ContextType`](../../../contexts/type-aliases/ContextType.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `"message_reaction"`>, `Macros`> | `object` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `trigger` | `MaybeArray`<[`TelegramReactionTypeEmojiEmoji`](../type-aliases/TelegramReactionTypeEmojiEmoji.md)> |
| `handler` | (`context`) => `unknown` |
| `options?` | `TOptions` |

#### Returns

`this`

#### Example

```ts
new Bot().reaction("👍", async (context) => {
    await context.reply(`Thank you!`);
});
```

***

### start()

> **start**(`__namedParameters?`): `Promise`<[`TelegramUser`](../interfaces/TelegramUser.md)>

Defined in: gramio/index.d.ts:1322

Start receive updates via long-polling or webhook

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters?` | [`BotStartOptions`](../interfaces/BotStartOptions.md) |

#### Returns

`Promise`<[`TelegramUser`](../interfaces/TelegramUser.md)>

#### Example

```ts
import { Bot } from "gramio";

const bot = new Bot("") // put you token here
    .command("start", (context) => context.send("Hi!"))
    .onStart(console.log);

bot.start();
```

***

### startParameter()

> **startParameter**<`TOptions`>(`parameter`, `handler`, `options?`): `this`

Defined in: gramio/index.d.ts:1297

Register handler to `start` command when start parameter is matched

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `TOptions` *extends* [`HandlerOptions`](../../../composer/type-aliases/HandlerOptions.md)<[`MessageContext`](../../../contexts/classes/MessageContext.md)<`Bot`<`Errors`, `Derives`, `Macros`>> & [`Require`](../../../contexts/type-aliases/Require.md)<[`MessageContext`](../../../contexts/classes/MessageContext.md)<`Bot`<`Errors`, `Derives`, `Macros`>>, `"from"`> & `Derives`\[`"global"`] & `Derives`\[`"message"`] & `object`, `Macros`> | `object` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `parameter` | `RegExp` | `MaybeArray`<`string`> |
| `handler` | [`Handler`](../type-aliases/Handler.md)<[`MessageContext`](../../../contexts/classes/MessageContext.md)<`Bot`<`Errors`, `Derives`, `Macros`>> & [`Require`](../../../contexts/type-aliases/Require.md)<[`MessageContext`](../../../contexts/classes/MessageContext.md)<`Bot`<`Errors`, `Derives`, `Macros`>>, `"from"`> & `Derives`\[`"global"`] & `Derives`\[`"message"`] & `object` & `UnionToIntersection`<{ \[K in string | number | symbol]: MacroDeriveType\<Macros\[K]> }\[keyof `TOptions` & keyof `Macros`]>> |
| `options?` | `TOptions` |

#### Returns

`this`

#### Example

```ts
new Bot().startParameter(/^ref_(.+)$/, (context) => {
    return context.send(`Reference: ${context.rawStartPayload}`);
});
```

***

### stop()

> **stop**(`timeout?`): `Promise`<`void`>

Defined in: gramio/index.d.ts:1326

Stops receiving events via long-polling or webhook

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `timeout?` | `number` |

#### Returns

`Promise`<`void`>

***

### use()

> **use**(`handler`): `this`

Defined in: gramio/index.d.ts:1144

Register handler to any Updates

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`Handler`](../type-aliases/Handler.md)<[`Context`](../../../contexts/classes/Context.md)<`Bot`<`Errors`, `Derives`, `Macros`>> & `Derives`\[`"global"`]> |

#### Returns

`this`

---

---
url: 'https://gramio.dev/api/contexts/classes/BotCommand.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BotCommand

# Class: BotCommand

Defined in: contexts/index.d.ts:1183

This object represents a bot command

## Constructors

### Constructor

> **new BotCommand**(`payload`): `BotCommand`

Defined in: contexts/index.d.ts:1185

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBotCommand`](../../../../gramio/interfaces/TelegramBotCommand.md) |

#### Returns

`BotCommand`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBotCommand`](../../../../gramio/interfaces/TelegramBotCommand.md) | contexts/index.d.ts:1184 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1187

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### command

#### Get Signature

> **get** **command**(): `string`

Defined in: contexts/index.d.ts:1189

Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.

##### Returns

`string`

***

### description

#### Get Signature

> **get** **description**(): `string`

Defined in: contexts/index.d.ts:1191

Description of the command; 1-256 characters

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/BotDescription.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BotDescription

# Class: BotDescription

Defined in: contexts/index.d.ts:1195

This object represents the bot's description.

## Constructors

### Constructor

> **new BotDescription**(`payload`): `BotDescription`

Defined in: contexts/index.d.ts:1197

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBotDescription`](../../../../gramio/interfaces/TelegramBotDescription.md) |

#### Returns

`BotDescription`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBotDescription`](../../../../gramio/interfaces/TelegramBotDescription.md) | contexts/index.d.ts:1196 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1199

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### description

#### Get Signature

> **get** **description**(): `string`

Defined in: contexts/index.d.ts:1201

The bot's description

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/BotShortDescription.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BotShortDescription

# Class: BotShortDescription

Defined in: contexts/index.d.ts:1205

This object represents the bot's short description.

## Constructors

### Constructor

> **new BotShortDescription**(`payload`): `BotShortDescription`

Defined in: contexts/index.d.ts:1207

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBotShortDescription`](../../../../gramio/interfaces/TelegramBotShortDescription.md) |

#### Returns

`BotShortDescription`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBotShortDescription`](../../../../gramio/interfaces/TelegramBotShortDescription.md) | contexts/index.d.ts:1206 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1209

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### description

#### Get Signature

> **get** **description**(): `string`

Defined in: contexts/index.d.ts:1211

The bot's short description

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/BusinessBotRights.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BusinessBotRights

# Class: BusinessBotRights

Defined in: contexts/index.d.ts:1219

Represents the rights of a business bot.

[Documentation](https://core.telegram.org/bots/api/#businessbotrights)

## Constructors

### Constructor

> **new BusinessBotRights**(`payload`): `BusinessBotRights`

Defined in: contexts/index.d.ts:1221

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBusinessBotRights`](../../../../gramio/interfaces/TelegramBusinessBotRights.md) |

#### Returns

`BusinessBotRights`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBusinessBotRights`](../../../../gramio/interfaces/TelegramBusinessBotRights.md) | contexts/index.d.ts:1220 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1223

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### canChangeGiftSettings

#### Get Signature

> **get** **canChangeGiftSettings**(): `boolean`

Defined in: contexts/index.d.ts:1264

True, if the bot can change the privacy settings pertaining to gifts for the business account

##### Returns

`boolean`

***

### canConvertGiftsToStars

#### Get Signature

> **get** **canConvertGiftsToStars**(): `boolean`

Defined in: contexts/index.d.ts:1272

True, if the bot can convert regular gifts owned by the business account to Telegram Stars

##### Returns

`boolean`

***

### canDeleteAllMessages

#### Get Signature

> **get** **canDeleteAllMessages**(): `boolean`

Defined in: contexts/index.d.ts:1244

True, if the bot can delete all private messages in managed chats

##### Returns

`boolean`

***

### canDeleteOutgoingMessages

#### Get Signature

> **get** **canDeleteOutgoingMessages**(): `boolean`

Defined in: contexts/index.d.ts:1236

True, if the bot can delete messages sent by the bot

##### Deprecated

Use `canDeleteSentMessages` instead

##### Returns

`boolean`

***

### canDeleteSentMessages

#### Get Signature

> **get** **canDeleteSentMessages**(): `boolean`

Defined in: contexts/index.d.ts:1240

True, if the bot can delete messages sent by the bot

##### Returns

`boolean`

***

### canEditBio

#### Get Signature

> **get** **canEditBio**(): `boolean`

Defined in: contexts/index.d.ts:1252

True, if the bot can edit the bio of the business account

##### Returns

`boolean`

***

### canEditName

#### Get Signature

> **get** **canEditName**(): `boolean`

Defined in: contexts/index.d.ts:1248

True, if the bot can edit the first and last name of the business account

##### Returns

`boolean`

***

### canEditProfilePhoto

#### Get Signature

> **get** **canEditProfilePhoto**(): `boolean`

Defined in: contexts/index.d.ts:1256

True, if the bot can edit the profile photo of the business account

##### Returns

`boolean`

***

### canEditUsername

#### Get Signature

> **get** **canEditUsername**(): `boolean`

Defined in: contexts/index.d.ts:1260

True, if the bot can edit the username of the business account

##### Returns

`boolean`

***

### canManageStories

#### Get Signature

> **get** **canManageStories**(): `boolean`

Defined in: contexts/index.d.ts:1284

True, if the bot can post, edit and delete stories on behalf of the business account

##### Returns

`boolean`

***

### canReadMessages

#### Get Signature

> **get** **canReadMessages**(): `boolean`

Defined in: contexts/index.d.ts:1231

True, if the bot can read messages in the private chats that had incoming messages in the last 24 hours

##### Returns

`boolean`

***

### canReply

#### Get Signature

> **get** **canReply**(): `boolean`

Defined in: contexts/index.d.ts:1227

True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours

##### Returns

`boolean`

***

### canTransferAndUpgradeGifts

#### Get Signature

> **get** **canTransferAndUpgradeGifts**(): `boolean`

Defined in: contexts/index.d.ts:1276

True, if the bot can transfer and upgrade gifts owned by the business account

##### Returns

`boolean`

***

### canTransferStars

#### Get Signature

> **get** **canTransferStars**(): `boolean`

Defined in: contexts/index.d.ts:1280

True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts

##### Returns

`boolean`

***

### canViewGiftsAndStars

#### Get Signature

> **get** **canViewGiftsAndStars**(): `boolean`

Defined in: contexts/index.d.ts:1268

True, if the bot can view gifts and the amount of Telegram Stars owned by the business account

##### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/contexts/classes/BusinessConnection.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BusinessConnection

# Class: BusinessConnection

Defined in: contexts/index.d.ts:1292

Describes the connection of the bot with a business account.

[Documentation](https://core.telegram.org/bots/api/#businessconnection)

## Extended by

* [`BusinessConnectionContext`](BusinessConnectionContext.md)

## Constructors

### Constructor

> **new BusinessConnection**(`payload`): `BusinessConnection`

Defined in: contexts/index.d.ts:1294

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBusinessConnection`](../../../../gramio/interfaces/TelegramBusinessConnection.md) |

#### Returns

`BusinessConnection`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBusinessConnection`](../../../../gramio/interfaces/TelegramBusinessConnection.md) | contexts/index.d.ts:1293 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1296

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### canReply

#### Get Signature

> **get** **canReply**(): `boolean`

Defined in: contexts/index.d.ts:1316

True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours

##### Returns

`boolean`

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:1312

Date the connection was established in Unix time

##### Returns

`number`

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:1300

Unique identifier of the business connection

##### Returns

`string`

***

### isEnabled

#### Get Signature

> **get** **isEnabled**(): `boolean`

Defined in: contexts/index.d.ts:1320

True, if the connection is active

##### Returns

`boolean`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

Defined in: contexts/index.d.ts:1304

Business account user that created the business connection

##### Returns

[`User`](User.md)

***

### userChatId

#### Get Signature

> **get** **userChatId**(): `number`

Defined in: contexts/index.d.ts:1308

Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/BusinessConnectionContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BusinessConnectionContext

# Class: BusinessConnectionContext\<Bot>

Defined in: contexts/index.d.ts:5315

This object  Describes the connection of the bot with a business account.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`BusinessConnectionContext`<`Bot`>>.[`BusinessConnection`](BusinessConnection.md).[`CloneMixin`](CloneMixin.md)<`Bot`, `BusinessConnectionContext`<`Bot`>, `BusinessConnectionContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new BusinessConnectionContext**<`Bot`>(`options`): `BusinessConnectionContext`<`Bot`>

Defined in: contexts/index.d.ts:5319

Create new BusinessConnectionContext

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `BusinessConnectionContextOptions`<`Bot`> |

#### Returns

`BusinessConnectionContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new BusinessConnectionContext**(...`args`): `BusinessConnectionContext`

Defined in: contexts/index.d.ts:5315

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`BusinessConnectionContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramBusinessConnection`](../../../../gramio/interfaces/TelegramBusinessConnection.md) | The raw data that is used for this Context | [`BusinessConnection`](BusinessConnection.md).[`payload`](BusinessConnection.md#payload) | contexts/index.d.ts:5317 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### canReply

#### Get Signature

> **get** **canReply**(): `boolean`

Defined in: contexts/index.d.ts:1316

True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours

##### Returns

`boolean`

#### Inherited from

[`BusinessConnection`](BusinessConnection.md).[`canReply`](BusinessConnection.md#canreply)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:1312

Date the connection was established in Unix time

##### Returns

`number`

#### Inherited from

[`BusinessConnection`](BusinessConnection.md).[`date`](BusinessConnection.md#date)

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:1300

Unique identifier of the business connection

##### Returns

`string`

#### Inherited from

[`BusinessConnection`](BusinessConnection.md).[`id`](BusinessConnection.md#id)

***

### isEnabled

#### Get Signature

> **get** **isEnabled**(): `boolean`

Defined in: contexts/index.d.ts:1320

True, if the connection is active

##### Returns

`boolean`

#### Inherited from

[`BusinessConnection`](BusinessConnection.md).[`isEnabled`](BusinessConnection.md#isenabled)

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

Defined in: contexts/index.d.ts:1304

Business account user that created the business connection

##### Returns

[`User`](User.md)

#### Inherited from

[`BusinessConnection`](BusinessConnection.md).[`user`](BusinessConnection.md#user)

***

### userChatId

#### Get Signature

> **get** **userChatId**(): `number`

Defined in: contexts/index.d.ts:1308

Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`BusinessConnection`](BusinessConnection.md).[`userChatId`](BusinessConnection.md#userchatid)

## Methods

### clone()

> **clone**(`options?`): `BusinessConnectionContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `BusinessConnectionContextOptions` |

#### Returns

`BusinessConnectionContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

---

---
url: 'https://gramio.dev/api/contexts/classes/BusinessIntro.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BusinessIntro

# Class: BusinessIntro

Defined in: contexts/index.d.ts:1328

Contains information about the start page settings of a Telegram Business account.

[Documentation](https://core.telegram.org/bots/api/#businessintro)

## Constructors

### Constructor

> **new BusinessIntro**(`payload`): `BusinessIntro`

Defined in: contexts/index.d.ts:1330

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBusinessIntro`](../../../../gramio/interfaces/TelegramBusinessIntro.md) |

#### Returns

`BusinessIntro`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBusinessIntro`](../../../../gramio/interfaces/TelegramBusinessIntro.md) | contexts/index.d.ts:1329 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1332

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### message

#### Get Signature

> **get** **message**(): `string`

Defined in: contexts/index.d.ts:1340

*Optional*. Message text of the business intro

##### Returns

`string`

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:1344

*Optional*. Sticker of the business intro

##### Returns

[`StickerAttachment`](StickerAttachment.md)

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:1336

*Optional*. Title text of the business intro

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/BusinessLocation.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BusinessLocation

# Class: BusinessLocation

Defined in: contexts/index.d.ts:1352

Contains information about the location of a Telegram Business account.

[Documentation](https://core.telegram.org/bots/api/#businesslocation)

## Constructors

### Constructor

> **new BusinessLocation**(`payload`): `BusinessLocation`

Defined in: contexts/index.d.ts:1354

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBusinessLocation`](../../../../gramio/interfaces/TelegramBusinessLocation.md) |

#### Returns

`BusinessLocation`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBusinessLocation`](../../../../gramio/interfaces/TelegramBusinessLocation.md) | contexts/index.d.ts:1353 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1356

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### address

#### Get Signature

> **get** **address**(): `string`

Defined in: contexts/index.d.ts:1360

Address of the business

##### Returns

`string`

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:1364

*Optional*. Location of the business

##### Returns

[`Location`](Location.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/BusinessMessagesDeleted.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BusinessMessagesDeleted

# Class: BusinessMessagesDeleted

Defined in: contexts/index.d.ts:1368

Describes the connection of the bot with a business account.

## Extended by

* [`BusinessMessagesDeletedContext`](BusinessMessagesDeletedContext.md)

## Constructors

### Constructor

> **new BusinessMessagesDeleted**(`payload`): `BusinessMessagesDeleted`

Defined in: contexts/index.d.ts:1370

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBusinessMessagesDeleted`](../../../../gramio/interfaces/TelegramBusinessMessagesDeleted.md) |

#### Returns

`BusinessMessagesDeleted`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBusinessMessagesDeleted`](../../../../gramio/interfaces/TelegramBusinessMessagesDeleted.md) | contexts/index.d.ts:1369 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1372

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:1374

Unique identifier of the business connection

##### Returns

`string`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:1376

Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.

##### Returns

[`Chat`](Chat.md)

***

### messageIds

#### Get Signature

> **get** **messageIds**(): `number`\[]

Defined in: contexts/index.d.ts:1378

A list of identifiers of deleted messages in the chat of the business account

##### Returns

`number`\[]

---

---
url: 'https://gramio.dev/api/contexts/classes/BusinessMessagesDeletedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BusinessMessagesDeletedContext

# Class: BusinessMessagesDeletedContext\<Bot>

Defined in: contexts/index.d.ts:5331

This object represents a boost added to a chat or changed.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`BusinessMessagesDeletedContext`<`Bot`>>.[`BusinessMessagesDeleted`](BusinessMessagesDeleted.md).[`CloneMixin`](CloneMixin.md)<`Bot`, `BusinessMessagesDeletedContext`<`Bot`>, `BusinessMessagesDeletedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new BusinessMessagesDeletedContext**<`Bot`>(`options`): `BusinessMessagesDeletedContext`<`Bot`>

Defined in: contexts/index.d.ts:5335

Create new BusinessMessagesDeletedContext

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `BusinessMessagesDeletedContextOptions`<`Bot`> |

#### Returns

`BusinessMessagesDeletedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new BusinessMessagesDeletedContext**(...`args`): `BusinessMessagesDeletedContext`

Defined in: contexts/index.d.ts:5331

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`BusinessMessagesDeletedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramBusinessMessagesDeleted`](../../../../gramio/interfaces/TelegramBusinessMessagesDeleted.md) | The raw data that is used for this Context | [`BusinessMessagesDeleted`](BusinessMessagesDeleted.md).[`payload`](BusinessMessagesDeleted.md#payload) | contexts/index.d.ts:5333 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:1374

Unique identifier of the business connection

##### Returns

`string`

#### Inherited from

[`BusinessMessagesDeleted`](BusinessMessagesDeleted.md).[`businessConnectionId`](BusinessMessagesDeleted.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:1376

Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`BusinessMessagesDeleted`](BusinessMessagesDeleted.md).[`chat`](BusinessMessagesDeleted.md#chat)

***

### messageIds

#### Get Signature

> **get** **messageIds**(): `number`\[]

Defined in: contexts/index.d.ts:1378

A list of identifiers of deleted messages in the chat of the business account

##### Returns

`number`\[]

#### Inherited from

[`BusinessMessagesDeleted`](BusinessMessagesDeleted.md).[`messageIds`](BusinessMessagesDeleted.md#messageids)

## Methods

### clone()

> **clone**(`options?`): `BusinessMessagesDeletedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `BusinessMessagesDeletedContextOptions` |

#### Returns

`BusinessMessagesDeletedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

---

---
url: 'https://gramio.dev/api/contexts/classes/BusinessOpeningHours.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BusinessOpeningHours

# Class: BusinessOpeningHours

Defined in: contexts/index.d.ts:1404

[Documentation](https://core.telegram.org/bots/api/#businessopeninghours)

## Constructors

### Constructor

> **new BusinessOpeningHours**(`payload`): `BusinessOpeningHours`

Defined in: contexts/index.d.ts:1406

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBusinessOpeningHours`](../../../../gramio/interfaces/TelegramBusinessOpeningHours.md) |

#### Returns

`BusinessOpeningHours`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBusinessOpeningHours`](../../../../gramio/interfaces/TelegramBusinessOpeningHours.md) | contexts/index.d.ts:1405 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1408

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### openingHours

#### Get Signature

> **get** **openingHours**(): [`TelegramBusinessOpeningHoursInterval`](../../../../gramio/interfaces/TelegramBusinessOpeningHoursInterval.md)\[]

Defined in: contexts/index.d.ts:1412

List of time intervals describing business opening hours

##### Returns

[`TelegramBusinessOpeningHoursInterval`](../../../../gramio/interfaces/TelegramBusinessOpeningHoursInterval.md)\[]

***

### timeZoneName

#### Get Signature

> **get** **timeZoneName**(): `string`

Defined in: contexts/index.d.ts:1410

Unique name of the time zone for which the opening hours are defined

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/BusinessOpeningHoursInterval.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BusinessOpeningHoursInterval

# Class: BusinessOpeningHoursInterval

Defined in: contexts/index.d.ts:1386

Describes an interval of time during which a business is open.

[Documentation](https://core.telegram.org/bots/api/#businessopeninghoursinterval)

## Constructors

### Constructor

> **new BusinessOpeningHoursInterval**(`payload`): `BusinessOpeningHoursInterval`

Defined in: contexts/index.d.ts:1388

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramBusinessOpeningHoursInterval`](../../../../gramio/interfaces/TelegramBusinessOpeningHoursInterval.md) |

#### Returns

`BusinessOpeningHoursInterval`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramBusinessOpeningHoursInterval`](../../../../gramio/interfaces/TelegramBusinessOpeningHoursInterval.md) | contexts/index.d.ts:1387 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1390

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### closingMinute

#### Get Signature

> **get** **closingMinute**(): `number`

Defined in: contexts/index.d.ts:1398

The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 \* 24 \* 60

##### Returns

`number`

***

### openingMinute

#### Get Signature

> **get** **openingMinute**(): `number`

Defined in: contexts/index.d.ts:1394

The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 \* 24 \* 60

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/callback-data/classes/CallbackData.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/callback-data/dist](../index.md) / CallbackData

# Class: CallbackData\<SchemaType, SchemaTypeInput>

Defined in: callback-data/index.d.ts:88

Class-helper that construct schema and serialize/deserialize with [CallbackData.pack](#pack) and [CallbackData.unpack](#unpack) methods

## Example

```typescript
const someData = new CallbackData("example").number("id");

new Bot()
    .command("start", (context) =>
        context.send("some", {
            reply_markup: new InlineKeyboard().text(
                "example",
                someData.pack({
                    id: 1,
                })
            ),
        })
    )
    .callbackQuery(someData, (context) => {
        context.queryData; // is type-safe
    });
```

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `SchemaType` *extends* `Record`<`string`, `any`> | `Record`<`never`, `never`> |
| `SchemaTypeInput` *extends* `Record`<`string`, `any`> | `Record`<`never`, `never`> |

## Constructors

### Constructor

> **new CallbackData**<`SchemaType`, `SchemaTypeInput`>(`nameId`): `CallbackData`<`SchemaType`, `SchemaTypeInput`>

Defined in: callback-data/index.d.ts:95

Pass the `id` with which you can identify the CallbackData

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `nameId` | `string` |

#### Returns

`CallbackData`<`SchemaType`, `SchemaTypeInput`>

## Properties

| Property | Modifier | Type | Description | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `id` | `public` | `string` | `id` for identify the CallbackData | callback-data/index.d.ts:91 |
|  `nameId` | `public` | `string` | - | callback-data/index.d.ts:89 |
|  `schema` | `protected` | `Schema` | - | callback-data/index.d.ts:93 |

## Methods

### boolean()

> **boolean**<`Key`, `Optional`, `Default`>(`key`, `options?`): `CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & AddFieldOutput<"boolean", Key, Optional, never, Default, never>)\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & AddFieldInput<"boolean", Key, Optional, never, Default, never>)\[Key] }>

Defined in: callback-data/index.d.ts:110

Add `boolean` property to schema

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Key` *extends* `string` | - |
| `Optional` *extends* `boolean` | `false` |
| `Default` *extends* `boolean` | `never` |

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key` | `Key` | Name of property |
| `options?` | `FieldOptions`<`"boolean"`, `Optional`, `never`, `Default`> | - |

#### Returns

`CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & AddFieldOutput<"boolean", Key, Optional, never, Default, never>)\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & AddFieldInput<"boolean", Key, Optional, never, Default, never>)\[Key] }>

***

### data()

> **data**<`Key`, `Optional`, `Data`>(`key`, `data`, `options?`): `CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & (Optional extends true ? { \[K in string]?: InferDataPack\<Data> } : { \[K in string]: InferDataPack\<Data> }))\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & (Optional extends true ? { \[K in string]?: InferDataPack\<Data> } : { \[K in string]: InferDataPack\<Data> }))\[Key] }>

Defined in: callback-data/index.d.ts:122

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Key` *extends* `string` | - |
| `Optional` *extends* `boolean` | `false` |
| `Data` *extends* `CallbackData`<`Record`<`never`, `never`>, `Record`<`never`, `never`>> | `never` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `key` | `Key` |
| `data` | `Data` |
| `options?` | `FieldOptions`<`"data"`, `Optional`, `never`> |

#### Returns

`CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & (Optional extends true ? { \[K in string]?: InferDataPack\<Data> } : { \[K in string]: InferDataPack\<Data> }))\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & (Optional extends true ? { \[K in string]?: InferDataPack\<Data> } : { \[K in string]: InferDataPack\<Data> }))\[Key] }>

***

### enum()

> **enum**<`Key`, `Optional`, `T`, `Default`>(`key`, `enumValues`, `options?`): `CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & AddFieldOutput<"enum", Key, Optional, T\[number], Default, never>)\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & AddFieldInput<"enum", Key, Optional, T\[number], Default, never>)\[Key] }>

Defined in: callback-data/index.d.ts:116

Add `enum` property to schema

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Key` *extends* `string` | - |
| `Optional` *extends* `boolean` | `false` |
| `T` *extends* `any`\[] | readonly `any`\[] | `never` |
| `Default` *extends* `any` | `never` |

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key` | `Key` | Name of property |
| `enumValues` | `T` | Enum values |
| `options?` | `FieldOptions`<`"enum"`, `Optional`, `T`, `Default`> | - |

#### Returns

`CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & AddFieldOutput<"enum", Key, Optional, T\[number], Default, never>)\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & AddFieldInput<"enum", Key, Optional, T\[number], Default, never>)\[Key] }>

***

### extend()

> **extend**<`OtherSchemaType`, `OtherSchemaTypeInput`>(`other`): `CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & OtherSchemaType)\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & OtherSchemaTypeInput)\[Key] }>

Defined in: callback-data/index.d.ts:173

#### Type Parameters

| Type Parameter |
| ------ |
| `OtherSchemaType` *extends* `Record`<`string`, `unknown`> |
| `OtherSchemaTypeInput` *extends* `Record`<`string`, `unknown`> |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `other` | `CallbackData`<`OtherSchemaType`, `OtherSchemaTypeInput`> |

#### Returns

`CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & OtherSchemaType)\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & OtherSchemaTypeInput)\[Key] }>

***

### filter()

> **filter**(`data`): `boolean`

Defined in: callback-data/index.d.ts:131

Method that return `true` if data is this CallbackData

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `data` | `string` | String with data |

#### Returns

`boolean`

***

### number()

> **number**<`Key`, `Optional`, `Default`>(`key`, `options?`): `CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & AddFieldOutput<"number", Key, Optional, never, Default, never>)\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & AddFieldInput<"number", Key, Optional, never, Default, never>)\[Key] }>

Defined in: callback-data/index.d.ts:105

Add `number` property to schema

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Key` *extends* `string` | - |
| `Optional` *extends* `boolean` | `false` |
| `Default` *extends* `number` | `never` |

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key` | `Key` | Name of property |
| `options?` | `FieldOptions`<`"number"`, `Optional`, `never`, `Default`> | - |

#### Returns

`CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & AddFieldOutput<"number", Key, Optional, never, Default, never>)\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & AddFieldInput<"number", Key, Optional, never, Default, never>)\[Key] }>

***

### pack()

> **pack**<`T`>(...`args`): `string`

Defined in: callback-data/index.d.ts:150

A method for [`serializing`](https://developer.mozilla.org/en-US/docs/Glossary/Serialization) **object data** defined by **schema** into a **string**

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `Record`<`string`, `any`> |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `IsOptionalType`<`SchemaTypeInput`> *extends* `true` ? \[`T`] : \[`T`] |

#### Returns

`string`

#### Example

```ts
const someData = new CallbackData("example").number("id");

context.send("some", {
	reply_markup: new InlineKeyboard().text(
		"example",
		someData.pack({
			id: 1,
		}),
	),
});
```

***

### regexp()

> **regexp**(): `RegExp`

Defined in: callback-data/index.d.ts:126

Method that return RegExp to match this CallbackData

#### Returns

`RegExp`

***

### safeUnpack()

> **safeUnpack**(`data`): [`SafeUnpackResult`](../type-aliases/SafeUnpackResult.md)<`SchemaType`>

Defined in: callback-data/index.d.ts:172

Safe version of [CallbackData.unpack](#unpack) that never throws.
Returns `{ success: true, data }` on success or `{ success: false, error }` on failure.

Useful for handling outdated callback data from old inline keyboards after schema changes.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `data` | `string` |

#### Returns

[`SafeUnpackResult`](../type-aliases/SafeUnpackResult.md)<`SchemaType`>

#### Example

```ts
const result = someData.safeUnpack(data);
if (result.success) {
    console.log(result.data);
} else {
    context.answerCallbackQuery("This button is outdated!");
}
```

***

### string()

> **string**<`Key`, `Optional`, `Default`>(`key`, `options?`): `CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & AddFieldOutput<"string", Key, Optional, never, Default, never>)\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & AddFieldInput<"string", Key, Optional, never, Default, never>)\[Key] }>

Defined in: callback-data/index.d.ts:100

Add `string` property to schema

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Key` *extends* `string` | - |
| `Optional` *extends* `boolean` | `false` |
| `Default` *extends* `string` | `never` |

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key` | `Key` | Name of property |
| `options?` | `FieldOptions`<`"string"`, `Optional`, `never`, `Default`> | - |

#### Returns

`CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & AddFieldOutput<"string", Key, Optional, never, Default, never>)\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & AddFieldInput<"string", Key, Optional, never, Default, never>)\[Key] }>

***

### unpack()

> **unpack**(`data`): `SchemaType`

Defined in: callback-data/index.d.ts:155

A method for [`deserializing`](https://developer.mozilla.org/en-US/docs/Glossary/Deserialization) data **object** by **schema** from a **string**

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `data` | `string` | String with data (please check that this string matched by [CallbackData.regexp](#regexp)) |

#### Returns

`SchemaType`

***

### uuid()

> **uuid**<`Key`, `Optional`, `Default`>(`key`, `options?`): `CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & AddFieldOutput<"uuid", Key, Optional, never, Default, never>)\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & AddFieldInput<"uuid", Key, Optional, never, Default, never>)\[Key] }>

Defined in: callback-data/index.d.ts:121

Add `uuid` property to schema

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Key` *extends* `string` | - |
| `Optional` *extends* `boolean` | `false` |
| `Default` *extends* `string` | `never` |

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key` | `Key` | Name of property |
| `options?` | `FieldOptions`<`"uuid"`, `Optional`, `never`, `Default`> | - |

#### Returns

`CallbackData`<{ \[Key in string | number | symbol]: (SchemaType & AddFieldOutput<"uuid", Key, Optional, never, Default, never>)\[Key] }, { \[Key in string | number | symbol]: (SchemaTypeInput & AddFieldInput<"uuid", Key, Optional, never, Default, never>)\[Key] }>

---

---
url: 'https://gramio.dev/api/contexts/classes/CallbackGame.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / CallbackGame

# Class: CallbackGame

Defined in: contexts/index.d.ts:1416

A placeholder, currently holds no information.

## Constructors

### Constructor

> **new CallbackGame**(`payload`): `CallbackGame`

Defined in: contexts/index.d.ts:1418

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramCallbackGame`](../../../../gramio/interfaces/TelegramCallbackGame.md) |

#### Returns

`CallbackGame`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramCallbackGame`](../../../../gramio/interfaces/TelegramCallbackGame.md) | contexts/index.d.ts:1417 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1420

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/CallbackQuery.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / CallbackQuery

# Class: CallbackQuery

Defined in: contexts/index.d.ts:3203

This object represents an incoming callback query from a callback button in
an inline keyboard. If the button that originated the query was attached to
a message sent by the bot, the field message will be present.
If the button was attached to a message sent via the bot (in inline mode),
the field inline\_message\_id will be present.
Exactly one of the fields `data` or `game_short_name` will be present.

## Extended by

* [`CallbackQueryContext`](CallbackQueryContext.md)

## Constructors

### Constructor

> **new CallbackQuery**(`payload`): `CallbackQuery`

Defined in: contexts/index.d.ts:3205

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramCallbackQuery`](../../../../gramio/interfaces/TelegramCallbackQuery.md) |

#### Returns

`CallbackQuery`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramCallbackQuery`](../../../../gramio/interfaces/TelegramCallbackQuery.md) | contexts/index.d.ts:3204 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3207

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### chatInstance

#### Get Signature

> **get** **chatInstance**(): `string`

Defined in: contexts/index.d.ts:3227

Global identifier, uniquely corresponding to the chat to which the message
with the callback button was sent. Useful for high scores in games.

##### Returns

`string`

***

### data

#### Get Signature

> **get** **data**(): `string`

Defined in: contexts/index.d.ts:3232

Data associated with the callback button.
Be aware that a bad client can send arbitrary data in this field.

##### Returns

`string`

#### Set Signature

> **set** **data**(`data`): `void`

Defined in: contexts/index.d.ts:3233

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `data` | `string` |

##### Returns

`void`

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3211

Sender

##### Returns

[`User`](User.md)

***

### gameShortName

#### Get Signature

> **get** **gameShortName**(): `string`

Defined in: contexts/index.d.ts:3238

Short name of a Game to be returned,
serves as the unique identifier for the game

##### Returns

`string`

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:3209

Unique identifier for this query

##### Returns

`string`

***

### inlineMessageId

#### Get Signature

> **get** **inlineMessageId**(): `string`

Defined in: contexts/index.d.ts:3222

Identifier of the message sent via the bot in inline mode,
that originated the query.

##### Returns

`string`

***

### message

#### Get Signature

> **get** **message**(): [`Message`](Message.md) | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3217

Message sent by the bot with the callback button that originated the query

##### Returns

[`Message`](Message.md) | [`InaccessibleMessage`](InaccessibleMessage.md)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:3213

Sender ID

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/CallbackQueryContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / CallbackQueryContext

# Class: CallbackQueryContext\<Bot>

Defined in: contexts/index.d.ts:5347

Called when `callback_query` event occurs

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`CallbackQueryContext`<`Bot`>>.[`CallbackQuery`](CallbackQuery.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `CallbackQueryContext`<`Bot`>, `CallbackQueryContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new CallbackQueryContext**<`Bot`>(`options`): `CallbackQueryContext`<`Bot`>

Defined in: contexts/index.d.ts:5350

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `CallbackQueryContextOptions`<`Bot`> |

#### Returns

`CallbackQueryContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new CallbackQueryContext**(...`args`): `CallbackQueryContext`

Defined in: contexts/index.d.ts:5347

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`CallbackQueryContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | [`TelegramCallbackQuery`](../../../../gramio/interfaces/TelegramCallbackQuery.md) | The raw data that is used for this Context | [`CallbackQuery`](CallbackQuery.md).[`payload`](CallbackQuery.md#payload) | contexts/index.d.ts:5349 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:5362

Chat identifier of the message with the callback button that originated the query.

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### chatInstance

#### Get Signature

> **get** **chatInstance**(): `string`

Defined in: contexts/index.d.ts:3227

Global identifier, uniquely corresponding to the chat to which the message
with the callback button was sent. Useful for high scores in games.

##### Returns

`string`

#### Inherited from

[`CallbackQuery`](CallbackQuery.md).[`chatInstance`](CallbackQuery.md#chatinstance)

***

### data

#### Get Signature

> **get** **data**(): `string`

Defined in: contexts/index.d.ts:3232

Data associated with the callback button.
Be aware that a bad client can send arbitrary data in this field.

##### Returns

`string`

#### Set Signature

> **set** **data**(`data`): `void`

Defined in: contexts/index.d.ts:3233

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `data` | `string` |

##### Returns

`void`

#### Inherited from

[`CallbackQuery`](CallbackQuery.md).[`data`](CallbackQuery.md#data)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3211

Sender

##### Returns

[`User`](User.md)

#### Inherited from

[`CallbackQuery`](CallbackQuery.md).[`from`](CallbackQuery.md#from)

***

### gameShortName

#### Get Signature

> **get** **gameShortName**(): `string`

Defined in: contexts/index.d.ts:3238

Short name of a Game to be returned,
serves as the unique identifier for the game

##### Returns

`string`

#### Inherited from

[`CallbackQuery`](CallbackQuery.md).[`gameShortName`](CallbackQuery.md#gameshortname)

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:3209

Unique identifier for this query

##### Returns

`string`

#### Inherited from

[`CallbackQuery`](CallbackQuery.md).[`id`](CallbackQuery.md#id)

***

### inlineMessageId

#### Get Signature

> **get** **inlineMessageId**(): `string`

Defined in: contexts/index.d.ts:3222

Identifier of the message sent via the bot in inline mode,
that originated the query.

##### Returns

`string`

#### Inherited from

[`CallbackQuery`](CallbackQuery.md).[`inlineMessageId`](CallbackQuery.md#inlinemessageid)

***

### message

#### Get Signature

> **get** **message**(): [`MessageContext`](MessageContext.md)<`Bot`>

Defined in: contexts/index.d.ts:5358

Message with the callback button that originated the query.
Note that message content and message date will not be available
if the message is too old

##### Returns

[`MessageContext`](MessageContext.md)<`Bot`>

#### Inherited from

[`CallbackQuery`](CallbackQuery.md).[`message`](CallbackQuery.md#message)

***

### queryPayload

#### Get Signature

> **get** **queryPayload**(): `unknown`

Defined in: contexts/index.d.ts:5369

Data associated with the callback button.
Be aware that a bad client can send arbitrary data in this field.

##### Returns

`unknown`

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:3213

Sender ID

##### Returns

`number`

#### Inherited from

[`CallbackQuery`](CallbackQuery.md).[`senderId`](CallbackQuery.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### answer()

> **answer**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5381

Answers to current callback query. An alias for `answerCallbackQuery`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | `string` | `Partial`<[`AnswerCallbackQueryParams`](../../../../gramio/interfaces/AnswerCallbackQueryParams.md)> |

#### Returns

`Promise`<`true`>

***

### answerCallbackQuery()

> **answerCallbackQuery**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5377

Answers to current callback query

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | `string` | `Partial`<[`AnswerCallbackQueryParams`](../../../../gramio/interfaces/AnswerCallbackQueryParams.md)> |

#### Returns

`Promise`<`true`>

***

### answerWebAppQuery()

> **answerWebAppQuery**(`params`): `Promise`<[`TelegramSentWebAppMessage`](../../../../gramio/interfaces/TelegramSentWebAppMessage.md)>

Defined in: contexts/index.d.ts:5379

Sets the result of an interaction with a Web App and sends a corresponding message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`AnswerWebAppQueryParams`](../../../../gramio/interfaces/AnswerWebAppQueryParams.md) |

#### Returns

`Promise`<[`TelegramSentWebAppMessage`](../../../../gramio/interfaces/TelegramSentWebAppMessage.md)>

***

### clone()

> **clone**(`options?`): `CallbackQueryContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `CallbackQueryContextOptions` |

#### Returns

`CallbackQueryContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)> | `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5385

Edits a callback query messages caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)> | `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)> | `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5389

Edits a callback query messages live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)> | `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)> | `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5387

Edits a callback query messages media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)> | `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)> | `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5393

Edits a callback query messages reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)> | `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)> | `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5383

Edits a callback query messages text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)> | `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasData()

> **hasData**(): `this is Require<CallbackQueryContext<Bot>, "data">`

Defined in: contexts/index.d.ts:5373

Checks if the query has `data` property

#### Returns

`this is Require<CallbackQueryContext<Bot>, "data">`

***

### hasGameShortName()

> **hasGameShortName**(): `this is Require<CallbackQueryContext<Bot>, "gameShortName">`

Defined in: contexts/index.d.ts:5375

Checks if the query has `gameShortName` property

#### Returns

`this is Require<CallbackQueryContext<Bot>, "gameShortName">`

***

### hasInlineMessageId()

> **hasInlineMessageId**(): `this is Require<CallbackQueryContext<Bot>, "inlineMessageId">`

Defined in: contexts/index.d.ts:5371

Checks if the query has `inlineMessageId` property

#### Returns

`this is Require<CallbackQueryContext<Bot>, "inlineMessageId">`

***

### hasMessage()

> **hasMessage**(): `this is Require<CallbackQueryContext<Bot>, "message">`

Defined in: contexts/index.d.ts:5352

Checks if the query has `message` property

#### Returns

`this is Require<CallbackQueryContext<Bot>, "message">`

***

### hasQueryPayload()

> **hasQueryPayload**(): `this is Require<CallbackQueryContext<Bot>, "queryPayload">`

Defined in: contexts/index.d.ts:5364

Checks if the query has `queryPayload` property

#### Returns

`this is Require<CallbackQueryContext<Bot>, "queryPayload">`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)> | `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5391

Stops a callback query messages live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)> | `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/Chat.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Chat

# Class: Chat

Defined in: contexts/index.d.ts:756

This object represents a chat.

[Documentation](https://core.telegram.org/bots/api/#chat)

## Constructors

### Constructor

> **new Chat**(`payload`): `Chat`

Defined in: contexts/index.d.ts:758

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChat`](../../../../gramio/interfaces/TelegramChat.md) |

#### Returns

`Chat`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChat`](../../../../gramio/interfaces/TelegramChat.md) | contexts/index.d.ts:757 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:760

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### firstName

#### Get Signature

> **get** **firstName**(): `string`

Defined in: contexts/index.d.ts:780

*Optional*. First name of the other party in a private chat

##### Returns

`string`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:764

Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

##### Returns

`number`

***

### isDirectMessages

#### Get Signature

> **get** **isDirectMessages**(): `true`

Defined in: contexts/index.d.ts:792

*Optional*. *True*, if the chat is the direct messages chat of a channel

##### Returns

`true`

***

### isForum

#### Get Signature

> **get** **isForum**(): `true`

Defined in: contexts/index.d.ts:788

*Optional*. *True*, if the supergroup chat is a forum (has [topics](https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups) enabled)

##### Returns

`true`

***

### lastName

#### Get Signature

> **get** **lastName**(): `string`

Defined in: contexts/index.d.ts:784

*Optional*. Last name of the other party in a private chat

##### Returns

`string`

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:772

*Optional*. Title, for supergroups, channels and group chats

##### Returns

`string`

***

### type

#### Get Signature

> **get** **type**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:768

Type of the chat, can be either “private”, “group”, “supergroup” or “channel”

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

***

### username

#### Get Signature

> **get** **username**(): `string`

Defined in: contexts/index.d.ts:776

*Optional*. Username, for private chats, supergroups and channels if available

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatActionMixin.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatActionMixin

# Class: ChatActionMixin\<Bot>

Defined in: contexts/index.d.ts:5260

Main base context

## Extends

* [`Context`](Context.md)<`Bot`>.[`SendMixin`](SendMixin.md)<`Bot`>

## Extended by

* [`BoostAddedContext`](BoostAddedContext.md)
* [`ChatBackgroundSetContext`](ChatBackgroundSetContext.md)
* [`ChatJoinRequestContext`](ChatJoinRequestContext.md)
* [`ChatMemberContext`](ChatMemberContext.md)
* [`ChatOwnerChangedContext`](ChatOwnerChangedContext.md)
* [`ChatOwnerLeftContext`](ChatOwnerLeftContext.md)
* [`ChatSharedContext`](ChatSharedContext.md)
* [`ChecklistTasksAddedContext`](ChecklistTasksAddedContext.md)
* [`ChecklistTasksDoneContext`](ChecklistTasksDoneContext.md)
* [`ChosenInlineResultContext`](ChosenInlineResultContext.md)
* [`DeleteChatPhotoContext`](DeleteChatPhotoContext.md)
* [`DirectMessagePriceChangedContext`](DirectMessagePriceChangedContext.md)
* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiftContext`](GiftContext.md)
* [`GiftUpgradeSentContext`](GiftUpgradeSentContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)
* [`GroupChatCreatedContext`](GroupChatCreatedContext.md)
* [`InvoiceContext`](InvoiceContext.md)
* [`LeftChatMemberContext`](LeftChatMemberContext.md)
* [`LocationContext`](LocationContext.md)
* [`MessageAutoDeleteTimerChangedContext`](MessageAutoDeleteTimerChangedContext.md)
* [`MessageContext`](MessageContext.md)
* [`MigrateFromChatIdContext`](MigrateFromChatIdContext.md)
* [`MigrateToChatIdContext`](MigrateToChatIdContext.md)
* [`NewChatMembersContext`](NewChatMembersContext.md)
* [`NewChatPhotoContext`](NewChatPhotoContext.md)
* [`NewChatTitleContext`](NewChatTitleContext.md)
* [`PaidMessagePriceChangedContext`](PaidMessagePriceChangedContext.md)
* [`PassportDataContext`](PassportDataContext.md)
* [`PinnedMessageContext`](PinnedMessageContext.md)
* [`PollAnswerContext`](PollAnswerContext.md)
* [`PreCheckoutQueryContext`](PreCheckoutQueryContext.md)
* [`ProximityAlertTriggeredContext`](ProximityAlertTriggeredContext.md)
* [`RefundedPaymentContext`](RefundedPaymentContext.md)
* [`ShippingQueryContext`](ShippingQueryContext.md)
* [`SuccessfulPaymentContext`](SuccessfulPaymentContext.md)
* [`SuggestedPostApprovalFailedContext`](SuggestedPostApprovalFailedContext.md)
* [`SuggestedPostApprovedContext`](SuggestedPostApprovedContext.md)
* [`SuggestedPostDeclinedContext`](SuggestedPostDeclinedContext.md)
* [`SuggestedPostPaidContext`](SuggestedPostPaidContext.md)
* [`SuggestedPostRefundedContext`](SuggestedPostRefundedContext.md)
* [`UniqueGiftContext`](UniqueGiftContext.md)
* [`UsersSharedContext`](UsersSharedContext.md)
* [`VideoChatEndedContext`](VideoChatEndedContext.md)
* [`VideoChatParticipantsInvitedContext`](VideoChatParticipantsInvitedContext.md)
* [`VideoChatScheduledContext`](VideoChatScheduledContext.md)
* [`VideoChatStartedContext`](VideoChatStartedContext.md)
* [`WebAppDataContext`](WebAppDataContext.md)
* [`WriteAccessAllowedContext`](WriteAccessAllowedContext.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChatActionMixin**<`Bot`>(): `ChatActionMixin`<`Bot`>

#### Returns

`ChatActionMixin`<`Bot`>

#### Inherited from

[`Context`](Context.md).[`constructor`](Context.md#constructor)

## Properties

| Property | Modifier | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4859

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4861

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`senderId`](SendMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatAdministratorRights.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatAdministratorRights

# Class: ChatAdministratorRights

Defined in: contexts/index.d.ts:3242

Represents the rights of an administrator in a chat.

## Constructors

### Constructor

> **new ChatAdministratorRights**(`payload`): `ChatAdministratorRights`

Defined in: contexts/index.d.ts:3244

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatAdministratorRights`](../../../../gramio/interfaces/TelegramChatAdministratorRights.md) |

#### Returns

`ChatAdministratorRights`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatAdministratorRights`](../../../../gramio/interfaces/TelegramChatAdministratorRights.md) | contexts/index.d.ts:3243 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3246

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

## Methods

### canChangeInfo()

> **canChangeInfo**(): `boolean`

Defined in: contexts/index.d.ts:3260

`true`, if the user is allowed to change the chat title, photo and other settings

#### Returns

`boolean`

***

### canDeleteMessages()

> **canDeleteMessages**(): `boolean`

Defined in: contexts/index.d.ts:3252

`true`, if the administrator can delete messages of other users

#### Returns

`boolean`

***

### canDeleteStories()

> **canDeleteStories**(): `boolean`

Defined in: contexts/index.d.ts:3274

`true`, if the administrator can delete stories posted by other users; channels only

#### Returns

`boolean`

***

### canEditMessages()

> **canEditMessages**(): `boolean`

Defined in: contexts/index.d.ts:3266

`true`, if the administrator can edit messages of other users and can pin messages; channels only

#### Returns

`boolean`

***

### canEditStories()

> **canEditStories**(): `boolean`

Defined in: contexts/index.d.ts:3272

`true`, if the administrator can edit stories posted by other users; channels only

#### Returns

`boolean`

***

### canInviteUsers()

> **canInviteUsers**(): `boolean`

Defined in: contexts/index.d.ts:3262

`true`, if the user is allowed to invite new users to the chat

#### Returns

`boolean`

***

### canManageChat()

> **canManageChat**(): `boolean`

Defined in: contexts/index.d.ts:3250

`true`, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege

#### Returns

`boolean`

***

### canManageDirectMessages()

> **canManageDirectMessages**(): `boolean`

Defined in: contexts/index.d.ts:3278

`true`, if the administrator can manage direct messages of the channel and decline suggested posts; channels only

#### Returns

`boolean`

***

### canManageTags()

> **canManageTags**(): `boolean`

Defined in: contexts/index.d.ts:3280

`true`, if the administrator can edit the tags of regular members; for groups and supergroups only

#### Returns

`boolean`

***

### canManageTopics()

> **canManageTopics**(): `boolean`

Defined in: contexts/index.d.ts:3276

`true`, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only

#### Returns

`boolean`

***

### canManageVideoChats()

> **canManageVideoChats**(): `boolean`

Defined in: contexts/index.d.ts:3254

`true`, if the administrator can manage video chats

#### Returns

`boolean`

***

### canPinMessages()

> **canPinMessages**(): `boolean`

Defined in: contexts/index.d.ts:3268

`true`, if the user is allowed to pin messages; groups and supergroups only

#### Returns

`boolean`

***

### canPostMessages()

> **canPostMessages**(): `boolean`

Defined in: contexts/index.d.ts:3264

`true`, if the administrator can post in the channel; channels only

#### Returns

`boolean`

***

### canPostStories()

> **canPostStories**(): `boolean`

Defined in: contexts/index.d.ts:3270

`true`, if the administrator can post stories in the channel; channels only

#### Returns

`boolean`

***

### canPromoteMembers()

> **canPromoteMembers**(): `boolean`

Defined in: contexts/index.d.ts:3258

`true`, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user)

#### Returns

`boolean`

***

### canRestrictMembers()

> **canRestrictMembers**(): `boolean`

Defined in: contexts/index.d.ts:3256

`true`, if the administrator can restrict, ban or unban chat members

#### Returns

`boolean`

***

### isAnonymous()

> **isAnonymous**(): `boolean`

Defined in: contexts/index.d.ts:3248

`true`, if the user's presence in the chat is hidden

#### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatBackground.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatBackground

# Class: ChatBackground

Defined in: contexts/index.d.ts:2401

This object represents a chat background.

[Documentation](https://core.telegram.org/bots/api/#chatbackground)

## Constructors

### Constructor

> **new ChatBackground**(`payload`): `ChatBackground`

Defined in: contexts/index.d.ts:2403

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatBackground`](../../../../gramio/interfaces/TelegramChatBackground.md) |

#### Returns

`ChatBackground`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatBackground`](../../../../gramio/interfaces/TelegramChatBackground.md) | contexts/index.d.ts:2402 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2405

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### type

#### Get Signature

> **get** **type**(): [`TelegramBackgroundType`](../../../../gramio/type-aliases/TelegramBackgroundType.md)

Defined in: contexts/index.d.ts:2409

Type of the background

##### Returns

[`TelegramBackgroundType`](../../../../gramio/type-aliases/TelegramBackgroundType.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatBackgroundSetContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatBackgroundSetContext

# Class: ChatBackgroundSetContext\<Bot>

Defined in: contexts/index.d.ts:5405

This object represents a service message about chat background set.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ChatBackgroundSetContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ChatBackgroundSetContext`<`Bot`>, `ChatBackgroundSetContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChatBackgroundSetContext**<`Bot`>(`options`): `ChatBackgroundSetContext`<`Bot`>

Defined in: contexts/index.d.ts:5408

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ChatBackgroundSetContextOptions`<`Bot`> |

#### Returns

`ChatBackgroundSetContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ChatBackgroundSetContext**(...`args`): `ChatBackgroundSetContext`

Defined in: contexts/index.d.ts:5405

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ChatBackgroundSetContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5407 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### type

#### Get Signature

> **get** **type**(): [`BackgroundTypeChatTheme`](BackgroundTypeChatTheme.md) | [`BackgroundTypeFill`](BackgroundTypeFill.md) | [`BackgroundTypePattern`](BackgroundTypePattern.md) | [`BackgroundTypeWallpaper`](BackgroundTypeWallpaper.md)

Defined in: contexts/index.d.ts:5410

Type of the background

##### Returns

[`BackgroundTypeChatTheme`](BackgroundTypeChatTheme.md) | [`BackgroundTypeFill`](BackgroundTypeFill.md) | [`BackgroundTypePattern`](BackgroundTypePattern.md) | [`BackgroundTypeWallpaper`](BackgroundTypeWallpaper.md)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `ChatBackgroundSetContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ChatBackgroundSetContextOptions` |

#### Returns

`ChatBackgroundSetContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChatBackgroundSetContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ChatBackgroundSetContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ChatBackgroundSetContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ChatBackgroundSetContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ChatBackgroundSetContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ChatBackgroundSetContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ChatBackgroundSetContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ChatBackgroundSetContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<ChatBackgroundSetContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ChatBackgroundSetContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ChatBackgroundSetContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ChatBackgroundSetContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatBoost.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatBoost

# Class: ChatBoost

Defined in: contexts/index.d.ts:3349

This object contains information about a chat boost.

## Constructors

### Constructor

> **new ChatBoost**(`payload`): `ChatBoost`

Defined in: contexts/index.d.ts:3351

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatBoost`](../../../../gramio/interfaces/TelegramChatBoost.md) |

#### Returns

`ChatBoost`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatBoost`](../../../../gramio/interfaces/TelegramChatBoost.md) | contexts/index.d.ts:3350 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3353

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### addDate

#### Get Signature

> **get** **addDate**(): `number`

Defined in: contexts/index.d.ts:3357

Point in time (Unix timestamp) when the chat was boosted

##### Returns

`number`

***

### expirationDate

#### Get Signature

> **get** **expirationDate**(): `number`

Defined in: contexts/index.d.ts:3359

Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged

##### Returns

`number`

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:3355

Unique identifier of the boost

##### Returns

`string`

***

### source

#### Get Signature

> **get** **source**(): [`ChatBoostSourcePremium`](ChatBoostSourcePremium.md) | [`ChatBoostSourceGiftCode`](ChatBoostSourceGiftCode.md) | [`ChatBoostSourceGiveaway`](ChatBoostSourceGiveaway.md)

Defined in: contexts/index.d.ts:3361

Source of the added boost

##### Returns

[`ChatBoostSourcePremium`](ChatBoostSourcePremium.md) | [`ChatBoostSourceGiftCode`](ChatBoostSourceGiftCode.md) | [`ChatBoostSourceGiveaway`](ChatBoostSourceGiveaway.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatBoostAdded.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatBoostAdded

# Class: ChatBoostAdded

Defined in: contexts/index.d.ts:2413

This object represents a service message about a user boosting a chat.

## Constructors

### Constructor

> **new ChatBoostAdded**(`payload`): `ChatBoostAdded`

Defined in: contexts/index.d.ts:2415

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatBoostAdded`](../../../../gramio/interfaces/TelegramChatBoostAdded.md) |

#### Returns

`ChatBoostAdded`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatBoostAdded`](../../../../gramio/interfaces/TelegramChatBoostAdded.md) | contexts/index.d.ts:2414 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2417

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### boostCount

#### Get Signature

> **get** **boostCount**(): `number`

Defined in: contexts/index.d.ts:2419

Number of boosts added by the user

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatBoostContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatBoostContext

# Class: ChatBoostContext\<Bot>

Defined in: contexts/index.d.ts:5422

This object represents a boost added to a chat or changed.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ChatBoostContext`<`Bot`>>.[`ChatBoostUpdated`](ChatBoostUpdated.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ChatBoostContext`<`Bot`>, `ChatBoostContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChatBoostContext**<`Bot`>(`options`): `ChatBoostContext`<`Bot`>

Defined in: contexts/index.d.ts:5425

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ChatBoostContextOptions`<`Bot`> |

#### Returns

`ChatBoostContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ChatBoostContext**(...`args`): `ChatBoostContext`

Defined in: contexts/index.d.ts:5422

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ChatBoostContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | [`TelegramChatBoostUpdated`](../../../../gramio/interfaces/TelegramChatBoostUpdated.md) | The raw data that is used for this Context | [`ChatBoostUpdated`](ChatBoostUpdated.md).[`payload`](ChatBoostUpdated.md#payload) | contexts/index.d.ts:5424 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### boost

#### Get Signature

> **get** **boost**(): [`ChatBoost`](ChatBoost.md)

Defined in: contexts/index.d.ts:3373

Information about the chat boost

##### Returns

[`ChatBoost`](ChatBoost.md)

#### Inherited from

[`ChatBoostUpdated`](ChatBoostUpdated.md).[`boost`](ChatBoostUpdated.md#boost)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:3371

Chat which was boosted

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`ChatBoostUpdated`](ChatBoostUpdated.md).[`chat`](ChatBoostUpdated.md#chat)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4859

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4861

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`senderId`](SendMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### clone()

> **clone**(`options?`): `ChatBoostContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ChatBoostContextOptions` |

#### Returns

`ChatBoostContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatBoostRemoved.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatBoostRemoved

# Class: ChatBoostRemoved

Defined in: contexts/index.d.ts:3333

This object represents a boost added to a chat or changed.

## Extended by

* [`RemovedChatBoostContext`](RemovedChatBoostContext.md)

## Constructors

### Constructor

> **new ChatBoostRemoved**(`payload`): `ChatBoostRemoved`

Defined in: contexts/index.d.ts:3335

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatBoostRemoved`](../../../../gramio/interfaces/TelegramChatBoostRemoved.md) |

#### Returns

`ChatBoostRemoved`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatBoostRemoved`](../../../../gramio/interfaces/TelegramChatBoostRemoved.md) | contexts/index.d.ts:3334 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3337

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:3339

Chat which was boosted

##### Returns

[`Chat`](Chat.md)

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:3341

Unique identifier of the boost

##### Returns

`string`

***

### removeDate

#### Get Signature

> **get** **removeDate**(): `number`

Defined in: contexts/index.d.ts:3343

Point in time (Unix timestamp) when the boost was removed

##### Returns

`number`

***

### source

#### Get Signature

> **get** **source**(): [`ChatBoostSourcePremium`](ChatBoostSourcePremium.md) | [`ChatBoostSourceGiftCode`](ChatBoostSourceGiftCode.md) | [`ChatBoostSourceGiveaway`](ChatBoostSourceGiveaway.md)

Defined in: contexts/index.d.ts:3345

Source of the removed boost

##### Returns

[`ChatBoostSourcePremium`](ChatBoostSourcePremium.md) | [`ChatBoostSourceGiftCode`](ChatBoostSourceGiftCode.md) | [`ChatBoostSourceGiveaway`](ChatBoostSourceGiveaway.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatBoostSourceGiftCode.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatBoostSourceGiftCode

# Class: ChatBoostSourceGiftCode

Defined in: contexts/index.d.ts:3323

The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.

## Extends

* `ChatBoostSource`

## Constructors

### Constructor

> **new ChatBoostSourceGiftCode**(`payload`): `ChatBoostSourceGiftCode`

Defined in: contexts/index.d.ts:3325

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatBoostSourceGiftCode`](../../../../gramio/interfaces/TelegramChatBoostSourceGiftCode.md) |

#### Returns

`ChatBoostSourceGiftCode`

#### Overrides

`ChatBoostSource.constructor`

## Properties

| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
|  `payload` | [`TelegramChatBoostSourceGiftCode`](../../../../gramio/interfaces/TelegramChatBoostSourceGiftCode.md) | `ChatBoostSource.payload` | contexts/index.d.ts:3324 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3317

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

`ChatBoostSource.[toStringTag]`

***

### source

#### Get Signature

> **get** **source**(): `"gift_code"`

Defined in: contexts/index.d.ts:3327

Source of the boost, always `gift_code`

##### Returns

`"gift_code"`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3329

User for which the gift code was created

##### Returns

[`User`](User.md)

## Methods

### is()

> **is**<`T`>(`source`): `this is ChatBoostSourceMapping[T]`

Defined in: contexts/index.d.ts:3319

Is this chat boost source a certain one?

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `"giveaway"` | `"premium"` | `"gift_code"` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `source` | `T` |

#### Returns

`this is ChatBoostSourceMapping[T]`

#### Inherited from

`ChatBoostSource.is`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatBoostSourceGiveaway.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatBoostSourceGiveaway

# Class: ChatBoostSourceGiveaway

Defined in: contexts/index.d.ts:3284

The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.

## Extends

* `ChatBoostSource`

## Constructors

### Constructor

> **new ChatBoostSourceGiveaway**(`payload`): `ChatBoostSourceGiveaway`

Defined in: contexts/index.d.ts:3286

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatBoostSourceGiveaway`](../../../../gramio/interfaces/TelegramChatBoostSourceGiveaway.md) |

#### Returns

`ChatBoostSourceGiveaway`

#### Overrides

`ChatBoostSource.constructor`

## Properties

| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
|  `payload` | [`TelegramChatBoostSourceGiveaway`](../../../../gramio/interfaces/TelegramChatBoostSourceGiveaway.md) | `ChatBoostSource.payload` | contexts/index.d.ts:3285 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3317

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

`ChatBoostSource.[toStringTag]`

***

### giveawayMessageId

#### Get Signature

> **get** **giveawayMessageId**(): `number`

Defined in: contexts/index.d.ts:3289

##### Returns

`number`

***

### prizeStarCount

#### Get Signature

> **get** **prizeStarCount**(): `number`

Defined in: contexts/index.d.ts:3295

The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only

##### Returns

`number`

***

### source

#### Get Signature

> **get** **source**(): `"giveaway"`

Defined in: contexts/index.d.ts:3288

Source of the boost, always `giveaway`

##### Returns

`"giveaway"`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3291

User that boosted the chat

##### Returns

[`User`](User.md)

## Methods

### is()

> **is**<`T`>(`source`): `this is ChatBoostSourceMapping[T]`

Defined in: contexts/index.d.ts:3319

Is this chat boost source a certain one?

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `"giveaway"` | `"premium"` | `"gift_code"` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `source` | `T` |

#### Returns

`this is ChatBoostSourceMapping[T]`

#### Inherited from

`ChatBoostSource.is`

***

### isUnclaimed()

> **isUnclaimed**(): `true`

Defined in: contexts/index.d.ts:3293

`true`, if the giveaway was completed, but there was no user to win the prize

#### Returns

`true`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatBoostSourcePremium.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatBoostSourcePremium

# Class: ChatBoostSourcePremium

Defined in: contexts/index.d.ts:3299

The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.

## Extends

* `ChatBoostSource`

## Constructors

### Constructor

> **new ChatBoostSourcePremium**(`payload`): `ChatBoostSourcePremium`

Defined in: contexts/index.d.ts:3301

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatBoostSourcePremium`](../../../../gramio/interfaces/TelegramChatBoostSourcePremium.md) |

#### Returns

`ChatBoostSourcePremium`

#### Overrides

`ChatBoostSource.constructor`

## Properties

| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
|  `payload` | [`TelegramChatBoostSourcePremium`](../../../../gramio/interfaces/TelegramChatBoostSourcePremium.md) | `ChatBoostSource.payload` | contexts/index.d.ts:3300 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3317

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

`ChatBoostSource.[toStringTag]`

***

### source

#### Get Signature

> **get** **source**(): `"premium"`

Defined in: contexts/index.d.ts:3303

Source of the boost, always `premium`

##### Returns

`"premium"`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3305

User that boosted the chat

##### Returns

[`User`](User.md)

## Methods

### is()

> **is**<`T`>(`source`): `this is ChatBoostSourceMapping[T]`

Defined in: contexts/index.d.ts:3319

Is this chat boost source a certain one?

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `"giveaway"` | `"premium"` | `"gift_code"` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `source` | `T` |

#### Returns

`this is ChatBoostSourceMapping[T]`

#### Inherited from

`ChatBoostSource.is`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatBoostUpdated.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatBoostUpdated

# Class: ChatBoostUpdated

Defined in: contexts/index.d.ts:3365

This object represents a boost added to a chat or changed.

## Extended by

* [`ChatBoostContext`](ChatBoostContext.md)

## Constructors

### Constructor

> **new ChatBoostUpdated**(`payload`): `ChatBoostUpdated`

Defined in: contexts/index.d.ts:3367

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatBoostUpdated`](../../../../gramio/interfaces/TelegramChatBoostUpdated.md) |

#### Returns

`ChatBoostUpdated`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatBoostUpdated`](../../../../gramio/interfaces/TelegramChatBoostUpdated.md) | contexts/index.d.ts:3366 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3369

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### boost

#### Get Signature

> **get** **boost**(): [`ChatBoost`](ChatBoost.md)

Defined in: contexts/index.d.ts:3373

Information about the chat boost

##### Returns

[`ChatBoost`](ChatBoost.md)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:3371

Chat which was boosted

##### Returns

[`Chat`](Chat.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatControlMixin.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatControlMixin

# Class: ChatControlMixin\<Bot>

Defined in: contexts/index.d.ts:5094

This object represents a mixin that is responsible for all the chat management methods

## Extends

* [`Context`](Context.md)<`Bot`>.[`TargetMixin`](TargetMixin.md).[`NodeMixin`](NodeMixin.md)<`Bot`>

## Extended by

* [`BoostAddedContext`](BoostAddedContext.md)
* [`ChatBackgroundSetContext`](ChatBackgroundSetContext.md)
* [`ChatMemberContext`](ChatMemberContext.md)
* [`ChecklistTasksAddedContext`](ChecklistTasksAddedContext.md)
* [`ChecklistTasksDoneContext`](ChecklistTasksDoneContext.md)
* [`DeleteChatPhotoContext`](DeleteChatPhotoContext.md)
* [`DirectMessagePriceChangedContext`](DirectMessagePriceChangedContext.md)
* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)
* [`GroupChatCreatedContext`](GroupChatCreatedContext.md)
* [`LeftChatMemberContext`](LeftChatMemberContext.md)
* [`LocationContext`](LocationContext.md)
* [`MessageContext`](MessageContext.md)
* [`NewChatMembersContext`](NewChatMembersContext.md)
* [`NewChatPhotoContext`](NewChatPhotoContext.md)
* [`NewChatTitleContext`](NewChatTitleContext.md)
* [`PinnedMessageContext`](PinnedMessageContext.md)
* [`ProximityAlertTriggeredContext`](ProximityAlertTriggeredContext.md)
* [`VideoChatEndedContext`](VideoChatEndedContext.md)
* [`VideoChatParticipantsInvitedContext`](VideoChatParticipantsInvitedContext.md)
* [`VideoChatScheduledContext`](VideoChatScheduledContext.md)
* [`VideoChatStartedContext`](VideoChatStartedContext.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChatControlMixin**<`Bot`>(): `ChatControlMixin`<`Bot`>

#### Returns

`ChatControlMixin`<`Bot`>

#### Inherited from

[`Context`](Context.md).[`constructor`](Context.md#constructor)

## Properties

| Property | Modifier | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | [`NodeMixin`](NodeMixin.md).[`isTopicMessage`](NodeMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | `Record`<`string`, `any`> | [`TargetMixin`](TargetMixin.md).[`payload`](TargetMixin.md#payload) | contexts/index.d.ts:4740 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4765

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`businessConnectionId`](TargetMixin.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4759

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chat`](TargetMixin.md#chat)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4744

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`from`](TargetMixin.md#from)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4944

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`id`](NodeMixin.md#id)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:4757

*Optional*. If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderBoostCount`](TargetMixin.md#senderboostcount)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4753

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderChat`](TargetMixin.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`threadId`](NodeMixin.md#threadid)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`getChatBoosts`](NodeMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChatControlMixin\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ChatControlMixin\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ChatControlMixin<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ChatControlMixin<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ChatControlMixin<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ChatControlMixin<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ChatControlMixin<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ChatControlMixin<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPM()

> **isPM**(): `this is RequireValue<ChatControlMixin<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ChatControlMixin<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ChatControlMixin<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ChatControlMixin<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`send`](NodeMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendAnimation`](NodeMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendAudio`](NodeMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendChatAction`](NodeMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendChecklist`](NodeMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendContact`](NodeMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendDice`](NodeMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendDocument`](NodeMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendInvoice`](NodeMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendLocation`](NodeMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendMedia`](NodeMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendMediaGroup`](NodeMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendMessageDraft`](NodeMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendPaidMedia`](NodeMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendPhoto`](NodeMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendPoll`](NodeMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendSticker`](NodeMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVenue`](NodeMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVideo`](NodeMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVideoNote`](NodeMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVoice`](NodeMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopPoll`](NodeMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`streamMessage`](NodeMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatFullInfo.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatFullInfo

# Class: ChatFullInfo

Defined in: contexts/index.d.ts:3521

This object contains full information about a chat.

[Documentation](https://core.telegram.org/bots/api/#chatfullinfo)

## Constructors

### Constructor

> **new ChatFullInfo**(`payload`): `ChatFullInfo`

Defined in: contexts/index.d.ts:3523

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatFullInfo`](../../../../gramio/interfaces/TelegramChatFullInfo.md) |

#### Returns

`ChatFullInfo`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatFullInfo`](../../../../gramio/interfaces/TelegramChatFullInfo.md) | contexts/index.d.ts:3522 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3525

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### accentColorId

#### Get Signature

> **get** **accentColorId**(): `number`

Defined in: contexts/index.d.ts:3561

Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See [accent colors](https://core.telegram.org/bots/api/#accent-colors) for more details.

##### Returns

`number`

***

### acceptedGiftTypes

#### Get Signature

> **get** **acceptedGiftTypes**(): [`AcceptedGiftTypes`](AcceptedGiftTypes.md)

Defined in: contexts/index.d.ts:3699

##### Returns

[`AcceptedGiftTypes`](AcceptedGiftTypes.md)

***

### activeUsernames

#### Get Signature

> **get** **activeUsernames**(): `string`\[]

Defined in: contexts/index.d.ts:3573

*Optional*. If non-empty, the list of all [active chat usernames](https://telegram.org/blog/topics-in-groups-collectible-usernames#collectible-usernames); for private chats, supergroups and channels

##### Returns

`string`\[]

***

### availableReactions

#### Get Signature

> **get** **availableReactions**(): [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)\[]

Defined in: contexts/index.d.ts:3601

*Optional*. List of available reactions allowed in the chat. If omitted, then all [emoji reactions](https://core.telegram.org/bots/api/#reactiontypeemoji) are allowed.

##### Returns

[`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)\[]

***

### backgroundCustomEmojiId

#### Get Signature

> **get** **backgroundCustomEmojiId**(): `string`

Defined in: contexts/index.d.ts:3605

*Optional*. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background

##### Returns

`string`

***

### bio

#### Get Signature

> **get** **bio**(): `string`

Defined in: contexts/index.d.ts:3625

*Optional*. Bio of the other party in a private chat

##### Returns

`string`

***

### birthdate

#### Get Signature

> **get** **birthdate**(): [`Birthdate`](Birthdate.md)

Defined in: contexts/index.d.ts:3577

*Optional*. For private chats, the date of birth of the user

##### Returns

[`Birthdate`](Birthdate.md)

***

### businessIntro

#### Get Signature

> **get** **businessIntro**(): [`BusinessIntro`](BusinessIntro.md)

Defined in: contexts/index.d.ts:3581

*Optional*. For private chats with business accounts, the intro of the business

##### Returns

[`BusinessIntro`](BusinessIntro.md)

***

### businessLocation

#### Get Signature

> **get** **businessLocation**(): [`BusinessLocation`](BusinessLocation.md)

Defined in: contexts/index.d.ts:3585

*Optional*. For private chats with business accounts, the location of the business

##### Returns

[`BusinessLocation`](BusinessLocation.md)

***

### businessOpeningHours

#### Get Signature

> **get** **businessOpeningHours**(): [`BusinessOpeningHours`](BusinessOpeningHours.md)

Defined in: contexts/index.d.ts:3589

*Optional*. For private chats with business accounts, the opening hours of the business

##### Returns

[`BusinessOpeningHours`](BusinessOpeningHours.md)

***

### canSendGift

#### Get Signature

> **get** **canSendGift**(): `boolean`

Defined in: contexts/index.d.ts:3698

##### Returns

`boolean`

***

### canSendPaidMedia

#### Get Signature

> **get** **canSendPaidMedia**(): `true`

Defined in: contexts/index.d.ts:3693

*Optional*. *True*, if the bot can change the group sticker set

##### Returns

`true`

***

### canSetStickerSet

#### Get Signature

> **get** **canSetStickerSet**(): `true`

Defined in: contexts/index.d.ts:3697

*Optional*. *True*, if the bot can change the group sticker set

##### Returns

`true`

***

### customEmojiStickerSetName

#### Get Signature

> **get** **customEmojiStickerSetName**(): `string`

Defined in: contexts/index.d.ts:3703

*Optional*. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.

##### Returns

`string`

***

### description

#### Get Signature

> **get** **description**(): `string`

Defined in: contexts/index.d.ts:3645

*Optional*. Description, for groups, supergroups and channel chats

##### Returns

`string`

***

### emojiStatusCustomEmojiId

#### Get Signature

> **get** **emojiStatusCustomEmojiId**(): `string`

Defined in: contexts/index.d.ts:3617

*Optional*. Custom emoji identifier of the emoji status of the chat or the other party in a private chat

##### Returns

`string`

***

### emojiStatusExpirationDate

#### Get Signature

> **get** **emojiStatusExpirationDate**(): `number`

Defined in: contexts/index.d.ts:3621

*Optional*. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any

##### Returns

`number`

***

### firstName

#### Get Signature

> **get** **firstName**(): `string`

Defined in: contexts/index.d.ts:3545

*Optional*. First name of the other party in a private chat

##### Returns

`string`

***

### firstProfileAudio

#### Get Signature

> **get** **firstProfileAudio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:3719

*Optional*. For private chats, the first audio added to the profile of the user

##### Returns

[`AudioAttachment`](AudioAttachment.md)

***

### hasAggressiveAntiSpamEnabled

#### Get Signature

> **get** **hasAggressiveAntiSpamEnabled**(): `true`

Defined in: contexts/index.d.ts:3673

*Optional*. *True*, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.

##### Returns

`true`

***

### hasHiddenMembers

#### Get Signature

> **get** **hasHiddenMembers**(): `true`

Defined in: contexts/index.d.ts:3677

*Optional*. *True*, if non-administrators can only get the list of bots and administrators in the chat

##### Returns

`true`

***

### hasPrivateForwards

#### Get Signature

> **get** **hasPrivateForwards**(): `true`

Defined in: contexts/index.d.ts:3629

*Optional*. *True*, if privacy settings of the other party in the private chat allows to use `tg://user?id=<user_id>` links only in chats with the user

##### Returns

`true`

***

### hasProtectedContent

#### Get Signature

> **get** **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:3681

*Optional*. *True*, if messages from the chat can't be forwarded to other chats

##### Returns

`true`

***

### hasRestrictedVoiceAndVideoMessages

#### Get Signature

> **get** **hasRestrictedVoiceAndVideoMessages**(): `true`

Defined in: contexts/index.d.ts:3633

*Optional*. *True*, if the privacy settings of the other party restrict sending voice and video note messages in the private chat

##### Returns

`true`

***

### hasVisibleHistory

#### Get Signature

> **get** **hasVisibleHistory**(): `true`

Defined in: contexts/index.d.ts:3685

*Optional*. *True*, if new chat members will have access to old messages; available only to chat administrators

##### Returns

`true`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:3529

Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

##### Returns

`number`

***

### inviteLink

#### Get Signature

> **get** **inviteLink**(): `string`

Defined in: contexts/index.d.ts:3649

*Optional*. Primary invite link, for groups, supergroups and channel chats

##### Returns

`string`

***

### isDirectMessages

#### Get Signature

> **get** **isDirectMessages**(): `true`

Defined in: contexts/index.d.ts:3557

*Optional*. *True*, if the chat is the direct messages chat of a channel

##### Returns

`true`

***

### isForum

#### Get Signature

> **get** **isForum**(): `true`

Defined in: contexts/index.d.ts:3553

*Optional*. *True*, if the supergroup chat is a forum (has [topics](https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups) enabled)

##### Returns

`true`

***

### joinByRequest

#### Get Signature

> **get** **joinByRequest**(): `true`

Defined in: contexts/index.d.ts:3641

*Optional*. *True*, if all users directly joining the supergroup need to be approved by supergroup administrators

##### Returns

`true`

***

### joinToSendMessages

#### Get Signature

> **get** **joinToSendMessages**(): `true`

Defined in: contexts/index.d.ts:3637

*Optional*. *True*, if users need to join the supergroup before they can send messages

##### Returns

`true`

***

### lastName

#### Get Signature

> **get** **lastName**(): `string`

Defined in: contexts/index.d.ts:3549

*Optional*. Last name of the other party in a private chat

##### Returns

`string`

***

### linkedChatId

#### Get Signature

> **get** **linkedChatId**(): `number`

Defined in: contexts/index.d.ts:3707

*Optional*. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.

##### Returns

`number`

***

### location

#### Get Signature

> **get** **location**(): [`ChatLocation`](ChatLocation.md)

Defined in: contexts/index.d.ts:3711

*Optional*. For supergroups, the location to which the supergroup is connected

##### Returns

[`ChatLocation`](ChatLocation.md)

***

### maxReactionCount

#### Get Signature

> **get** **maxReactionCount**(): `number`

Defined in: contexts/index.d.ts:3565

The maximum number of reactions that can be set on a message in the chat

##### Returns

`number`

***

### messageAutoDeleteTime

#### Get Signature

> **get** **messageAutoDeleteTime**(): `number`

Defined in: contexts/index.d.ts:3669

*Optional*. The time after which all messages sent to the chat will be automatically deleted; in seconds

##### Returns

`number`

***

### paidMessageStarCount

#### Get Signature

> **get** **paidMessageStarCount**(): `number`

Defined in: contexts/index.d.ts:3727

*Optional*. The number of Telegram Stars a general user have to pay to send a message to the chat

##### Returns

`number`

***

### parentChat

#### Get Signature

> **get** **parentChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:3597

*Optional*. Information about the corresponding channel chat; for direct messages chats only

##### Returns

[`Chat`](Chat.md)

***

### permissions

#### Get Signature

> **get** **permissions**(): [`ChatPermissions`](ChatPermissions.md)

Defined in: contexts/index.d.ts:3657

*Optional*. Default chat member permissions, for groups and supergroups

##### Returns

[`ChatPermissions`](ChatPermissions.md)

***

### personalChat

#### Get Signature

> **get** **personalChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:3593

*Optional*. For private chats, the personal channel of the user

##### Returns

[`Chat`](Chat.md)

***

### photo

#### Get Signature

> **get** **photo**(): [`ChatPhoto`](ChatPhoto.md)

Defined in: contexts/index.d.ts:3569

*Optional*. Chat photo

##### Returns

[`ChatPhoto`](ChatPhoto.md)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): [`Message`](Message.md)

Defined in: contexts/index.d.ts:3653

*Optional*. The most recent pinned message (by sending date)

##### Returns

[`Message`](Message.md)

***

### profileAccentColorId

#### Get Signature

> **get** **profileAccentColorId**(): `number`

Defined in: contexts/index.d.ts:3609

*Optional*. Identifier of the accent color for the chat's profile background. See [profile accent colors](https://core.telegram.org/bots/api/#profile-accent-colors) for more details.

##### Returns

`number`

***

### profileBackgroundCustomEmojiId

#### Get Signature

> **get** **profileBackgroundCustomEmojiId**(): `string`

Defined in: contexts/index.d.ts:3613

*Optional*. Custom emoji identifier of the emoji chosen by the chat for its profile background

##### Returns

`string`

***

### rating

#### Get Signature

> **get** **rating**(): [`UserRating`](UserRating.md)

Defined in: contexts/index.d.ts:3715

*Optional*. For private chats, the rating of the user if any

##### Returns

[`UserRating`](UserRating.md)

***

### slowModeDelay

#### Get Signature

> **get** **slowModeDelay**(): `number`

Defined in: contexts/index.d.ts:3661

*Optional*. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds

##### Returns

`number`

***

### stickerSetName

#### Get Signature

> **get** **stickerSetName**(): `string`

Defined in: contexts/index.d.ts:3689

*Optional*. For supergroups, name of the group sticker set

##### Returns

`string`

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:3537

*Optional*. Title, for supergroups, channels and group chats

##### Returns

`string`

***

### type

#### Get Signature

> **get** **type**(): [`TelegramChatFullInfoType`](../../../../gramio/type-aliases/TelegramChatFullInfoType.md)

Defined in: contexts/index.d.ts:3533

Type of the chat, can be either “private”, “group”, “supergroup” or “channel”

##### Returns

[`TelegramChatFullInfoType`](../../../../gramio/type-aliases/TelegramChatFullInfoType.md)

***

### uniqueGiftColors

#### Get Signature

> **get** **uniqueGiftColors**(): [`UniqueGiftColors`](UniqueGiftColors.md)

Defined in: contexts/index.d.ts:3723

*Optional*. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews

##### Returns

[`UniqueGiftColors`](UniqueGiftColors.md)

***

### unrestrictBoostCount

#### Get Signature

> **get** **unrestrictBoostCount**(): `number`

Defined in: contexts/index.d.ts:3665

*Optional*. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions

##### Returns

`number`

***

### username

#### Get Signature

> **get** **username**(): `string`

Defined in: contexts/index.d.ts:3541

*Optional*. Username, for private chats, supergroups and channels if available

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatInviteControlMixin.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatInviteControlMixin

# Class: ChatInviteControlMixin\<Bot>

Defined in: contexts/index.d.ts:5116

This object represents a mixin that works with all `*ChatInviteLink` methods

## Extends

* [`Context`](Context.md)<`Bot`>.[`TargetMixin`](TargetMixin.md)

## Extended by

* [`BoostAddedContext`](BoostAddedContext.md)
* [`ChatBackgroundSetContext`](ChatBackgroundSetContext.md)
* [`ChatJoinRequestContext`](ChatJoinRequestContext.md)
* [`ChecklistTasksAddedContext`](ChecklistTasksAddedContext.md)
* [`ChecklistTasksDoneContext`](ChecklistTasksDoneContext.md)
* [`DeleteChatPhotoContext`](DeleteChatPhotoContext.md)
* [`DirectMessagePriceChangedContext`](DirectMessagePriceChangedContext.md)
* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)
* [`GroupChatCreatedContext`](GroupChatCreatedContext.md)
* [`LeftChatMemberContext`](LeftChatMemberContext.md)
* [`LocationContext`](LocationContext.md)
* [`MessageContext`](MessageContext.md)
* [`MigrateFromChatIdContext`](MigrateFromChatIdContext.md)
* [`MigrateToChatIdContext`](MigrateToChatIdContext.md)
* [`NewChatMembersContext`](NewChatMembersContext.md)
* [`NewChatPhotoContext`](NewChatPhotoContext.md)
* [`NewChatTitleContext`](NewChatTitleContext.md)
* [`PinnedMessageContext`](PinnedMessageContext.md)
* [`ProximityAlertTriggeredContext`](ProximityAlertTriggeredContext.md)
* [`VideoChatEndedContext`](VideoChatEndedContext.md)
* [`VideoChatParticipantsInvitedContext`](VideoChatParticipantsInvitedContext.md)
* [`VideoChatScheduledContext`](VideoChatScheduledContext.md)
* [`VideoChatStartedContext`](VideoChatStartedContext.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChatInviteControlMixin**<`Bot`>(): `ChatInviteControlMixin`<`Bot`>

#### Returns

`ChatInviteControlMixin`<`Bot`>

#### Inherited from

[`Context`](Context.md).[`constructor`](Context.md#constructor)

## Properties

| Property | Modifier | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | `Record`<`string`, `any`> | [`TargetMixin`](TargetMixin.md).[`payload`](TargetMixin.md#payload) | contexts/index.d.ts:4740 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4765

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`businessConnectionId`](TargetMixin.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4759

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chat`](TargetMixin.md#chat)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4744

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`from`](TargetMixin.md#from)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:4757

*Optional*. If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderBoostCount`](TargetMixin.md#senderboostcount)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4753

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderChat`](TargetMixin.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

## Methods

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

***

### hasFrom()

> **hasFrom**(): this is Require\<ChatInviteControlMixin\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ChatInviteControlMixin\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ChatInviteControlMixin<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ChatInviteControlMixin<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ChatInviteControlMixin<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ChatInviteControlMixin<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ChatInviteControlMixin<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ChatInviteControlMixin<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPM()

> **isPM**(): `this is RequireValue<ChatInviteControlMixin<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ChatInviteControlMixin<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ChatInviteControlMixin<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ChatInviteControlMixin<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatInviteLink.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatInviteLink

# Class: ChatInviteLink

Defined in: contexts/index.d.ts:3731

Represents an invite link for a chat.

## Constructors

### Constructor

> **new ChatInviteLink**(`payload`): `ChatInviteLink`

Defined in: contexts/index.d.ts:3733

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md) |

#### Returns

`ChatInviteLink`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md) | contexts/index.d.ts:3732 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3735

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### createsJoinRequest

#### Get Signature

> **get** **createsJoinRequest**(): `boolean`

Defined in: contexts/index.d.ts:3758

`true`, if users joining the chat via the link need to be approved by chat administrators

##### Returns

`boolean`

***

### creator

#### Get Signature

> **get** **creator**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3742

Creator of the link

##### Returns

[`User`](User.md)

***

### expireDate

#### Get Signature

> **get** **expireDate**(): `number`

Defined in: contexts/index.d.ts:3750

Point in time (Unix timestamp) when the link will expire or has been expired

##### Returns

`number`

***

### link

#### Get Signature

> **get** **link**(): `string`

Defined in: contexts/index.d.ts:3740

The invite link. If the link was created by another chat administrator,
then the second part of the link will be replaced with `…`.

##### Returns

`string`

***

### memberLimit

#### Get Signature

> **get** **memberLimit**(): `number`

Defined in: contexts/index.d.ts:3756

Maximum number of users that can be members of the chat simultaneously
after joining the chat via this invite link;
`1-99999`

##### Returns

`number`

***

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: contexts/index.d.ts:3744

Invite link name

##### Returns

`string`

***

### pendingJoinRequestCount

#### Get Signature

> **get** **pendingJoinRequestCount**(): `number`

Defined in: contexts/index.d.ts:3760

Number of pending join requests created using this link

##### Returns

`number`

## Methods

### isPrimary()

> **isPrimary**(): `boolean`

Defined in: contexts/index.d.ts:3746

`true`, if the link is primary

#### Returns

`boolean`

***

### isRevoked()

> **isRevoked**(): `boolean`

Defined in: contexts/index.d.ts:3748

`true`, if the link is revoked

#### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatJoinRequest.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatJoinRequest

# Class: ChatJoinRequest

Defined in: contexts/index.d.ts:3764

Represents a join request sent to a chat.

## Extended by

* [`ChatJoinRequestContext`](ChatJoinRequestContext.md)

## Constructors

### Constructor

> **new ChatJoinRequest**(`payload`): `ChatJoinRequest`

Defined in: contexts/index.d.ts:3766

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatJoinRequest`](../../../../gramio/interfaces/TelegramChatJoinRequest.md) |

#### Returns

`ChatJoinRequest`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatJoinRequest`](../../../../gramio/interfaces/TelegramChatJoinRequest.md) | contexts/index.d.ts:3765 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3768

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### bio

#### Get Signature

> **get** **bio**(): `string`

Defined in: contexts/index.d.ts:3778

Bio of the user

##### Returns

`string`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:3770

Chat to which the request was sent

##### Returns

[`Chat`](Chat.md)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:3776

Date the request was sent in Unix time

##### Returns

`number`

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3772

User that sent the join request

##### Returns

[`User`](User.md)

***

### inviteLink

#### Get Signature

> **get** **inviteLink**(): [`ChatInviteLink`](ChatInviteLink.md)

Defined in: contexts/index.d.ts:3780

Chat invite link that was used by the user to send the join request

##### Returns

[`ChatInviteLink`](ChatInviteLink.md)

***

### userChatId

#### Get Signature

> **get** **userChatId**(): `number`

Defined in: contexts/index.d.ts:3774

Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatJoinRequestContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatJoinRequestContext

# Class: ChatJoinRequestContext\<Bot>

Defined in: contexts/index.d.ts:5441

Represents a join request sent to a chat.

[Documentation](https://core.telegram.org/bots/api/#chatjoinrequest)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ChatJoinRequestContext`<`Bot`>>.[`ChatJoinRequest`](ChatJoinRequest.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ChatJoinRequestContext`<`Bot`>, `ChatJoinRequestContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChatJoinRequestContext**<`Bot`>(`options`): `ChatJoinRequestContext`<`Bot`>

Defined in: contexts/index.d.ts:5444

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ChatJoinRequestContextOptions`<`Bot`> |

#### Returns

`ChatJoinRequestContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ChatJoinRequestContext**(...`args`): `ChatJoinRequestContext`

Defined in: contexts/index.d.ts:5441

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ChatJoinRequestContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | [`TelegramChatJoinRequest`](../../../../gramio/interfaces/TelegramChatJoinRequest.md) | The raw data that is used for this Context | [`ChatJoinRequest`](ChatJoinRequest.md).[`payload`](ChatJoinRequest.md#payload) | contexts/index.d.ts:5443 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### bio

#### Get Signature

> **get** **bio**(): `string`

Defined in: contexts/index.d.ts:3778

Bio of the user

##### Returns

`string`

#### Inherited from

[`ChatJoinRequest`](ChatJoinRequest.md).[`bio`](ChatJoinRequest.md#bio)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4765

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`businessConnectionId`](TargetMixin.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:3770

Chat to which the request was sent

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`ChatJoinRequest`](ChatJoinRequest.md).[`chat`](ChatJoinRequest.md#chat)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:3776

Date the request was sent in Unix time

##### Returns

`number`

#### Inherited from

[`ChatJoinRequest`](ChatJoinRequest.md).[`date`](ChatJoinRequest.md#date)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3772

User that sent the join request

##### Returns

[`User`](User.md)

#### Inherited from

[`ChatJoinRequest`](ChatJoinRequest.md).[`from`](ChatJoinRequest.md#from)

***

### inviteLink

#### Get Signature

> **get** **inviteLink**(): [`ChatInviteLink`](ChatInviteLink.md)

Defined in: contexts/index.d.ts:3780

Chat invite link that was used by the user to send the join request

##### Returns

[`ChatInviteLink`](ChatInviteLink.md)

#### Inherited from

[`ChatJoinRequest`](ChatJoinRequest.md).[`inviteLink`](ChatJoinRequest.md#invitelink)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:4757

*Optional*. If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderBoostCount`](TargetMixin.md#senderboostcount)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4753

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderChat`](TargetMixin.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

***

### userChatId

#### Get Signature

> **get** **userChatId**(): `number`

Defined in: contexts/index.d.ts:3774

Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.

##### Returns

`number`

#### Inherited from

[`ChatJoinRequest`](ChatJoinRequest.md).[`userChatId`](ChatJoinRequest.md#userchatid)

## Methods

### approve()

> **approve**(): `Promise`<`true`>

Defined in: contexts/index.d.ts:5446

Approves chat join request

#### Returns

`Promise`<`true`>

***

### clone()

> **clone**(`options?`): `ChatJoinRequestContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ChatJoinRequestContextOptions` |

#### Returns

`ChatJoinRequestContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### decline()

> **decline**(): `Promise`<`true`>

Defined in: contexts/index.d.ts:5448

Declines chat join request

#### Returns

`Promise`<`true`>

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChatJoinRequestContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ChatJoinRequestContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ChatJoinRequestContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ChatJoinRequestContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ChatJoinRequestContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ChatJoinRequestContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ChatJoinRequestContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ChatJoinRequestContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPM()

> **isPM**(): `this is RequireValue<ChatJoinRequestContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ChatJoinRequestContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ChatJoinRequestContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ChatJoinRequestContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatLocation.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatLocation

# Class: ChatLocation

Defined in: contexts/index.d.ts:3377

Represents a location to which a chat is connected.

## Constructors

### Constructor

> **new ChatLocation**(`payload`): `ChatLocation`

Defined in: contexts/index.d.ts:3379

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatLocation`](../../../../gramio/interfaces/TelegramChatLocation.md) |

#### Returns

`ChatLocation`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatLocation`](../../../../gramio/interfaces/TelegramChatLocation.md) | contexts/index.d.ts:3378 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3381

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### address

#### Get Signature

> **get** **address**(): `string`

Defined in: contexts/index.d.ts:3385

Location address; `1-64` characters, as defined by the chat owner

##### Returns

`string`

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3383

The location to which the supergroup is connected. Can't be a live location.

##### Returns

[`Location`](Location.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatMember.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatMember

# Class: ChatMember

Defined in: contexts/index.d.ts:3792

This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:

* `ChatMemberOwner`
* `ChatMemberAdministrator`
* `ChatMemberMember`
* `ChatMemberRestricted`
* `ChatMemberLeft`
* `ChatMemberBanned`

## Constructors

### Constructor

> **new ChatMember**(`payload`): `ChatMember`

Defined in: contexts/index.d.ts:3794

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `Record`<`string`, `any`> & [`TelegramChatMemberOwner`](../../../../gramio/interfaces/TelegramChatMemberOwner.md) | `Record`<`string`, `any`> & [`TelegramChatMemberAdministrator`](../../../../gramio/interfaces/TelegramChatMemberAdministrator.md) | `Record`<`string`, `any`> & [`TelegramChatMemberMember`](../../../../gramio/interfaces/TelegramChatMemberMember.md) | `Record`<`string`, `any`> & [`TelegramChatMemberRestricted`](../../../../gramio/interfaces/TelegramChatMemberRestricted.md) | `Record`<`string`, `any`> & [`TelegramChatMemberLeft`](../../../../gramio/interfaces/TelegramChatMemberLeft.md) | `Record`<`string`, `any`> & [`TelegramChatMemberBanned`](../../../../gramio/interfaces/TelegramChatMemberBanned.md) |

#### Returns

`ChatMember`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | `Record`<`string`, `any`> & [`TelegramChatMemberOwner`](../../../../gramio/interfaces/TelegramChatMemberOwner.md) | `Record`<`string`, `any`> & [`TelegramChatMemberAdministrator`](../../../../gramio/interfaces/TelegramChatMemberAdministrator.md) | `Record`<`string`, `any`> & [`TelegramChatMemberMember`](../../../../gramio/interfaces/TelegramChatMemberMember.md) | `Record`<`string`, `any`> & [`TelegramChatMemberRestricted`](../../../../gramio/interfaces/TelegramChatMemberRestricted.md) | `Record`<`string`, `any`> & [`TelegramChatMemberLeft`](../../../../gramio/interfaces/TelegramChatMemberLeft.md) | `Record`<`string`, `any`> & [`TelegramChatMemberBanned`](../../../../gramio/interfaces/TelegramChatMemberBanned.md) | contexts/index.d.ts:3793 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3796

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### customTitle

#### Get Signature

> **get** **customTitle**(): `string`

Defined in: contexts/index.d.ts:3802

Owner and administrators only. Custom title for this user

##### Returns

`string`

***

### status

#### Get Signature

> **get** **status**(): `"creator"` | `"administrator"` | `"member"` | `"restricted"` | `"left"` | `"kicked"`

Defined in: contexts/index.d.ts:3800

The member's status in the chat

##### Returns

`"creator"` | `"administrator"` | `"member"` | `"restricted"` | `"left"` | `"kicked"`

***

### tag

#### Get Signature

> **get** **tag**(): `string`

Defined in: contexts/index.d.ts:3890

Tag of the member; for members and restricted members

##### Returns

`string`

***

### untilDate

#### Get Signature

> **get** **untilDate**(): `number`

Defined in: contexts/index.d.ts:3810

Restricted and kicked only.
Date when restrictions will be lifted for this user;
unix time

##### Returns

`number`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3798

Information about the user

##### Returns

[`User`](User.md)

## Methods

### canAddWebPagePreviews()

> **canAddWebPagePreviews**(): `boolean`

Defined in: contexts/index.d.ts:3928

Restricted only
`true`, if the user is allowed to add web page previews to their messages

#### Returns

`boolean`

***

### canBeEdited()

> **canBeEdited**(): `boolean`

Defined in: contexts/index.d.ts:3816

Administrators only.
`true`, if the bot is allowed to edit administrator privileges of that
user

#### Returns

`boolean`

***

### canChangeInfo()

> **canChangeInfo**(): `boolean`

Defined in: contexts/index.d.ts:3865

Administrators and restricted only.
`true`, if the user is allowed to change the chat title,
photo and other settings

#### Returns

`boolean`

***

### canDeleteMessages()

> **canDeleteMessages**(): `boolean`

Defined in: contexts/index.d.ts:3841

Administrators only.
`true`, if the administrator can delete messages of other users

#### Returns

`boolean`

***

### canDeleteStories()

> **canDeleteStories**(): `any`

Defined in: contexts/index.d.ts:3882

`true`, if the administrator can delete stories posted by other users; channels only

#### Returns

`any`

***

### canEditMessages()

> **canEditMessages**(): `boolean`

Defined in: contexts/index.d.ts:3836

Administrators only.
`true`, if the administrator can edit messages of other users
and can pin messages; channels only

#### Returns

`boolean`

***

### canEditStories()

> **canEditStories**(): `any`

Defined in: contexts/index.d.ts:3880

`true`, if the administrator can edit stories posted by other users; channels only

#### Returns

`any`

***

### canEditTag()

> **canEditTag**(): `boolean`

Defined in: contexts/index.d.ts:3892

`true`, if the user is allowed to edit their own tag; for restricted members

#### Returns

`boolean`

***

### canInviteUsers()

> **canInviteUsers**(): `boolean`

Defined in: contexts/index.d.ts:3870

Administrators and restricted only.
`true`, if the user is allowed to invite new users to the chat

#### Returns

`boolean`

***

### canManageChat()

> **canManageChat**(): `boolean`

Defined in: contexts/index.d.ts:3824

Administrators only.
`true`, if the administrator can access the chat event log, chat statistics,
message statistics in channels, see channel members, see anonymous administrators
in supergroups and ignore slow mode.
Implied by any other administrator privilege

#### Returns

`boolean`

***

### canManageDirectMessages()

> **canManageDirectMessages**(): `boolean`

Defined in: contexts/index.d.ts:3886

`true`, if the administrator can manage direct messages of the channel and decline suggested posts; channels only

#### Returns

`boolean`

***

### canManageTags()

> **canManageTags**(): `boolean`

Defined in: contexts/index.d.ts:3888

`true`, if the administrator can edit the tags of regular members; for groups and supergroups only

#### Returns

`boolean`

***

### canManageTopics()

> **canManageTopics**(): `boolean`

Defined in: contexts/index.d.ts:3884

`true`, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only

#### Returns

`boolean`

***

### canManageVideoChats()

> **canManageVideoChats**(): `boolean`

Defined in: contexts/index.d.ts:3846

Administrators only.
`true`, if the administrator can manage video chats

#### Returns

`boolean`

***

### canPinMessages()

> **canPinMessages**(): `boolean`

Defined in: contexts/index.d.ts:3876

Administrators and restricted only.
`true`, if the user is allowed to pin messages;
groups and supergroups only

#### Returns

`boolean`

***

### canPostMessages()

> **canPostMessages**(): `boolean`

Defined in: contexts/index.d.ts:3830

Administrators only.
`true`, if the administrator can post in the channel;
channels only

#### Returns

`boolean`

***

### canPostStories()

> **canPostStories**(): `any`

Defined in: contexts/index.d.ts:3878

`true`, if the administrator can post stories in the channel; channels only

#### Returns

`any`

***

### canPromoteMembers()

> **canPromoteMembers**(): `boolean`

Defined in: contexts/index.d.ts:3859

Administrators only.
`true`, if the administrator can add new administrators with a subset o
their own privileges or demote administrators that he has promoted,
directly or indirectly (promoted by administrators that were appointed by
the user)

#### Returns

`boolean`

***

### canRestrictMembers()

> **canRestrictMembers**(): `boolean`

Defined in: contexts/index.d.ts:3851

Administrators only.
`true`, if the administrator can restrict, ban or unban chat members

#### Returns

`boolean`

***

### canSendAudios()

> **canSendAudios**(): `boolean`

Defined in: contexts/index.d.ts:3905

`true`, if the user is allowed to send audios

#### Returns

`boolean`

***

### canSendDocuments()

> **canSendDocuments**(): `boolean`

Defined in: contexts/index.d.ts:3907

`true`, if the user is allowed to send documents

#### Returns

`boolean`

***

### canSendMessages()

> **canSendMessages**(): `boolean`

Defined in: contexts/index.d.ts:3903

Restricted only.
`true`, if the user is allowed to send text messages,
contacts, locations and venues

#### Returns

`boolean`

***

### canSendOtherMessages()

> **canSendOtherMessages**(): `boolean`

Defined in: contexts/index.d.ts:3923

Restricted only.
`true`, if the user is allowed to send animations, games,
stickers and use inline bots

#### Returns

`boolean`

***

### canSendPhotos()

> **canSendPhotos**(): `boolean`

Defined in: contexts/index.d.ts:3909

`true`, if the user is allowed to send photos

#### Returns

`boolean`

***

### canSendPolls()

> **canSendPolls**(): `boolean`

Defined in: contexts/index.d.ts:3917

Restricted only. `true`, if the user is allowed to send polls

#### Returns

`boolean`

***

### canSendVideoNotes()

> **canSendVideoNotes**(): `boolean`

Defined in: contexts/index.d.ts:3913

`true`, if the user is allowed to send video notes

#### Returns

`boolean`

***

### canSendVideos()

> **canSendVideos**(): `boolean`

Defined in: contexts/index.d.ts:3911

`true`, if the user is allowed to send videos

#### Returns

`boolean`

***

### canSendVoiceNotes()

> **canSendVoiceNotes**(): `boolean`

Defined in: contexts/index.d.ts:3915

`true`, if the user is allowed to send voice notes

#### Returns

`boolean`

***

### isAnonymous()

> **isAnonymous**(): `boolean`

Defined in: contexts/index.d.ts:3804

Owner and administrators only. `true`, if the user's presence in the chat is hidden

#### Returns

`boolean`

***

### isMember()

> **isMember**(): `boolean`

Defined in: contexts/index.d.ts:3897

Restricted only.
`true`, if the user is a member of the chat at the moment of the request

#### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatMemberContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatMemberContext

# Class: ChatMemberContext\<Bot>

Defined in: contexts/index.d.ts:5505

This object represents changes in the status of a chat member.

[Documentation](https://core.telegram.org/bots/api/#chatmemberupdated)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ChatMemberContext`<`Bot`>>.[`ChatMemberUpdated`](ChatMemberUpdated.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ChatMemberContext`<`Bot`>, `ChatMemberContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChatMemberContext**<`Bot`>(`options`): `ChatMemberContext`<`Bot`>

Defined in: contexts/index.d.ts:5508

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ChatMemberContextOptions`<`Bot`> |

#### Returns

`ChatMemberContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ChatMemberContext**(...`args`): `ChatMemberContext`

Defined in: contexts/index.d.ts:5505

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ChatMemberContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | [`TelegramChatMemberUpdated`](../../../../gramio/interfaces/TelegramChatMemberUpdated.md) | The raw data that is used for this Context | [`ChatMemberUpdated`](ChatMemberUpdated.md).[`payload`](ChatMemberUpdated.md#payload) | contexts/index.d.ts:5507 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4765

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`businessConnectionId`](TargetMixin.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:3944

Chat the user belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`ChatMemberUpdated`](ChatMemberUpdated.md).[`chat`](ChatMemberUpdated.md#chat)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:3952

Date the change was done in Unix time

##### Returns

`number`

#### Inherited from

[`ChatMemberUpdated`](ChatMemberUpdated.md).[`date`](ChatMemberUpdated.md#date)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3948

Performer of the action, which resulted in the change

##### Returns

[`User`](User.md)

#### Inherited from

[`ChatMemberUpdated`](ChatMemberUpdated.md).[`from`](ChatMemberUpdated.md#from)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4944

##### Returns

`number`

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`id`](ChatControlMixin.md#id)

***

### inviteLink

#### Get Signature

> **get** **inviteLink**(): [`ChatInviteLink`](ChatInviteLink.md)

Defined in: contexts/index.d.ts:3964

*Optional*. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.

##### Returns

[`ChatInviteLink`](ChatInviteLink.md)

#### Inherited from

[`ChatMemberUpdated`](ChatMemberUpdated.md).[`inviteLink`](ChatMemberUpdated.md#invitelink)

***

### newChatMember

#### Get Signature

> **get** **newChatMember**(): [`ChatMember`](ChatMember.md)

Defined in: contexts/index.d.ts:3960

New information about the chat member

##### Returns

[`ChatMember`](ChatMember.md)

#### Inherited from

[`ChatMemberUpdated`](ChatMemberUpdated.md).[`newChatMember`](ChatMemberUpdated.md#newchatmember)

***

### oldChatMember

#### Get Signature

> **get** **oldChatMember**(): [`ChatMember`](ChatMember.md)

Defined in: contexts/index.d.ts:3956

Previous information about the chat member

##### Returns

[`ChatMember`](ChatMember.md)

#### Inherited from

[`ChatMemberUpdated`](ChatMemberUpdated.md).[`oldChatMember`](ChatMemberUpdated.md#oldchatmember)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:4757

*Optional*. If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderBoostCount`](TargetMixin.md#senderboostcount)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4753

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderChat`](TargetMixin.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

***

### viaChatFolderInviteLink

#### Get Signature

> **get** **viaChatFolderInviteLink**(): `boolean`

Defined in: contexts/index.d.ts:3972

*Optional*. True, if the user joined the chat via a chat folder invite link

##### Returns

`boolean`

#### Inherited from

[`ChatMemberUpdated`](ChatMemberUpdated.md).[`viaChatFolderInviteLink`](ChatMemberUpdated.md#viachatfolderinvitelink)

***

### viaJoinRequest

#### Get Signature

> **get** **viaJoinRequest**(): `boolean`

Defined in: contexts/index.d.ts:3968

*Optional*. True, if the user joined the chat after sending a direct join request and being approved by an administrator

##### Returns

`boolean`

#### Inherited from

[`ChatMemberUpdated`](ChatMemberUpdated.md).[`viaJoinRequest`](ChatMemberUpdated.md#viajoinrequest)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`clearReactions`](ChatControlMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `ChatMemberContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ChatMemberContextOptions` |

#### Returns

`ChatMemberContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`copy`](ChatControlMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`copyMessages`](ChatControlMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`delete`](ChatControlMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteMessages`](ChatControlMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`editCaption`](ChatControlMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`editChecklist`](ChatControlMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`editLiveLocation`](ChatControlMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`editMedia`](ChatControlMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`editMessageCaption`](ChatControlMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`editMessageLiveLocation`](ChatControlMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`editMessageMedia`](ChatControlMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`editMessageReplyMarkup`](ChatControlMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`editMessageText`](ChatControlMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`editReplyMarkup`](ChatControlMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`editText`](ChatControlMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`forward`](ChatControlMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`forwardMessages`](ChatControlMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChatMemberContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ChatMemberContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasInviteLink()

> **hasInviteLink**(): `this is Require<ChatMemberContext<Bot>, "inviteLink">`

Defined in: contexts/index.d.ts:5510

Does this update have `invite_link` property?

#### Returns

`this is Require<ChatMemberContext<Bot>, "inviteLink">`

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ChatMemberContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ChatMemberContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ChatMemberContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ChatMemberContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ChatMemberContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ChatMemberContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPM()

> **isPM**(): `this is RequireValue<ChatMemberContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ChatMemberContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ChatMemberContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ChatMemberContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithAnimation`](ChatControlMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithAudio`](ChatControlMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithContact`](ChatControlMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithDice`](ChatControlMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithDocument`](ChatControlMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithInvoice`](ChatControlMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithLocation`](ChatControlMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithMediaGroup`](ChatControlMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithPhoto`](ChatControlMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithPoll`](ChatControlMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithSticker`](ChatControlMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithVenue`](ChatControlMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithVideo`](ChatControlMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithVideoNote`](ChatControlMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`quoteWithVoice`](ChatControlMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`react`](ChatControlMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`reply`](ChatControlMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithAnimation`](ChatControlMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithAudio`](ChatControlMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithContact`](ChatControlMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithDice`](ChatControlMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithDocument`](ChatControlMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithInvoice`](ChatControlMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithLocation`](ChatControlMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithMediaGroup`](ChatControlMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithPhoto`](ChatControlMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithPoll`](ChatControlMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithQuote`](ChatControlMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithSticker`](ChatControlMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithVenue`](ChatControlMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithVideo`](ChatControlMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithVideoNote`](ChatControlMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`replyWithVoice`](ChatControlMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setReaction`](ChatControlMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setReactions`](ChatControlMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`stopLiveLocation`](ChatControlMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`stopMessageLiveLocation`](ChatControlMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatMemberControlMixin.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatMemberControlMixin

# Class: ChatMemberControlMixin\<Bot>

Defined in: contexts/index.d.ts:5130

This object represents a mixin that is able to control member's rights

## Extends

* [`Context`](Context.md)<`Bot`>.[`TargetMixin`](TargetMixin.md).[`NodeMixin`](NodeMixin.md)<`Bot`>

## Extended by

* [`BoostAddedContext`](BoostAddedContext.md)
* [`ChatBackgroundSetContext`](ChatBackgroundSetContext.md)
* [`ChecklistTasksAddedContext`](ChecklistTasksAddedContext.md)
* [`ChecklistTasksDoneContext`](ChecklistTasksDoneContext.md)
* [`DeleteChatPhotoContext`](DeleteChatPhotoContext.md)
* [`DirectMessagePriceChangedContext`](DirectMessagePriceChangedContext.md)
* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)
* [`GroupChatCreatedContext`](GroupChatCreatedContext.md)
* [`LeftChatMemberContext`](LeftChatMemberContext.md)
* [`LocationContext`](LocationContext.md)
* [`MessageContext`](MessageContext.md)
* [`NewChatMembersContext`](NewChatMembersContext.md)
* [`NewChatPhotoContext`](NewChatPhotoContext.md)
* [`NewChatTitleContext`](NewChatTitleContext.md)
* [`PinnedMessageContext`](PinnedMessageContext.md)
* [`ProximityAlertTriggeredContext`](ProximityAlertTriggeredContext.md)
* [`VideoChatEndedContext`](VideoChatEndedContext.md)
* [`VideoChatParticipantsInvitedContext`](VideoChatParticipantsInvitedContext.md)
* [`VideoChatScheduledContext`](VideoChatScheduledContext.md)
* [`VideoChatStartedContext`](VideoChatStartedContext.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChatMemberControlMixin**<`Bot`>(): `ChatMemberControlMixin`<`Bot`>

#### Returns

`ChatMemberControlMixin`<`Bot`>

#### Inherited from

[`Context`](Context.md).[`constructor`](Context.md#constructor)

## Properties

| Property | Modifier | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | [`NodeMixin`](NodeMixin.md).[`isTopicMessage`](NodeMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | `Record`<`string`, `any`> | [`TargetMixin`](TargetMixin.md).[`payload`](TargetMixin.md#payload) | contexts/index.d.ts:4740 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4765

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`businessConnectionId`](TargetMixin.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4759

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chat`](TargetMixin.md#chat)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4744

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`from`](TargetMixin.md#from)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4944

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`id`](NodeMixin.md#id)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:4757

*Optional*. If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderBoostCount`](TargetMixin.md#senderboostcount)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4753

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderChat`](TargetMixin.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`threadId`](NodeMixin.md#threadid)

## Methods

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`getChatBoosts`](NodeMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChatMemberControlMixin\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ChatMemberControlMixin\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ChatMemberControlMixin<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ChatMemberControlMixin<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ChatMemberControlMixin<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ChatMemberControlMixin<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ChatMemberControlMixin<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ChatMemberControlMixin<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPM()

> **isPM**(): `this is RequireValue<ChatMemberControlMixin<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ChatMemberControlMixin<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ChatMemberControlMixin<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ChatMemberControlMixin<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`send`](NodeMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendAnimation`](NodeMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendAudio`](NodeMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendChatAction`](NodeMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendChecklist`](NodeMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendContact`](NodeMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendDice`](NodeMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendDocument`](NodeMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendInvoice`](NodeMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendLocation`](NodeMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendMedia`](NodeMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendMediaGroup`](NodeMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendMessageDraft`](NodeMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendPaidMedia`](NodeMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendPhoto`](NodeMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendPoll`](NodeMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendSticker`](NodeMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVenue`](NodeMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVideo`](NodeMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVideoNote`](NodeMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVoice`](NodeMixin.md#sendvoice)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopPoll`](NodeMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`streamMessage`](NodeMixin.md#streammessage)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatMemberUpdated.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatMemberUpdated

# Class: ChatMemberUpdated

Defined in: contexts/index.d.ts:3936

This object represents changes in the status of a chat member.

[Documentation](https://core.telegram.org/bots/api/#chatmemberupdated)

## Extended by

* [`ChatMemberContext`](ChatMemberContext.md)

## Constructors

### Constructor

> **new ChatMemberUpdated**(`payload`): `ChatMemberUpdated`

Defined in: contexts/index.d.ts:3938

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatMemberUpdated`](../../../../gramio/interfaces/TelegramChatMemberUpdated.md) |

#### Returns

`ChatMemberUpdated`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatMemberUpdated`](../../../../gramio/interfaces/TelegramChatMemberUpdated.md) | contexts/index.d.ts:3937 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3940

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:3944

Chat the user belongs to

##### Returns

[`Chat`](Chat.md)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:3952

Date the change was done in Unix time

##### Returns

`number`

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3948

Performer of the action, which resulted in the change

##### Returns

[`User`](User.md)

***

### inviteLink

#### Get Signature

> **get** **inviteLink**(): [`ChatInviteLink`](ChatInviteLink.md)

Defined in: contexts/index.d.ts:3964

*Optional*. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.

##### Returns

[`ChatInviteLink`](ChatInviteLink.md)

***

### newChatMember

#### Get Signature

> **get** **newChatMember**(): [`ChatMember`](ChatMember.md)

Defined in: contexts/index.d.ts:3960

New information about the chat member

##### Returns

[`ChatMember`](ChatMember.md)

***

### oldChatMember

#### Get Signature

> **get** **oldChatMember**(): [`ChatMember`](ChatMember.md)

Defined in: contexts/index.d.ts:3956

Previous information about the chat member

##### Returns

[`ChatMember`](ChatMember.md)

***

### viaChatFolderInviteLink

#### Get Signature

> **get** **viaChatFolderInviteLink**(): `boolean`

Defined in: contexts/index.d.ts:3972

*Optional*. True, if the user joined the chat via a chat folder invite link

##### Returns

`boolean`

***

### viaJoinRequest

#### Get Signature

> **get** **viaJoinRequest**(): `boolean`

Defined in: contexts/index.d.ts:3968

*Optional*. True, if the user joined the chat after sending a direct join request and being approved by an administrator

##### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatOwnerChanged.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatOwnerChanged

# Class: ChatOwnerChanged

Defined in: contexts/index.d.ts:2427

Describes a service message about an ownership change in the chat.

[Documentation](https://core.telegram.org/bots/api/#chatownerchanged)

## Constructors

### Constructor

> **new ChatOwnerChanged**(`payload`): `ChatOwnerChanged`

Defined in: contexts/index.d.ts:2429

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatOwnerChanged`](../../../../gramio/interfaces/TelegramChatOwnerChanged.md) |

#### Returns

`ChatOwnerChanged`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatOwnerChanged`](../../../../gramio/interfaces/TelegramChatOwnerChanged.md) | contexts/index.d.ts:2428 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2431

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### newOwner

#### Get Signature

> **get** **newOwner**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2435

The new owner of the chat

##### Returns

[`User`](User.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatOwnerChangedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatOwnerChangedContext

# Class: ChatOwnerChangedContext\<Bot>

Defined in: contexts/index.d.ts:5460

This object represents a service message about an ownership change in the chat.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ChatOwnerChangedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ChatOwnerChangedContext`<`Bot`>, `ChatOwnerChangedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChatOwnerChangedContext**<`Bot`>(`options`): `ChatOwnerChangedContext`<`Bot`>

Defined in: contexts/index.d.ts:5464

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ChatOwnerChangedContextOptions`<`Bot`> |

#### Returns

`ChatOwnerChangedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ChatOwnerChangedContext**(...`args`): `ChatOwnerChangedContext`

Defined in: contexts/index.d.ts:5460

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ChatOwnerChangedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5462 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:5466

Service message: chat owner changed information

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### newOwner

#### Get Signature

> **get** **newOwner**(): [`User`](User.md)

Defined in: contexts/index.d.ts:5468

The new owner of the chat

##### Returns

[`User`](User.md)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `ChatOwnerChangedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ChatOwnerChangedContextOptions` |

#### Returns

`ChatOwnerChangedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChatOwnerChangedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ChatOwnerChangedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ChatOwnerChangedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ChatOwnerChangedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ChatOwnerChangedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ChatOwnerChangedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ChatOwnerChangedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ChatOwnerChangedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<ChatOwnerChangedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ChatOwnerChangedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ChatOwnerChangedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ChatOwnerChangedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatOwnerLeft.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatOwnerLeft

# Class: ChatOwnerLeft

Defined in: contexts/index.d.ts:2443

Describes a service message about the chat owner leaving the chat.

[Documentation](https://core.telegram.org/bots/api/#chatownerleft)

## Constructors

### Constructor

> **new ChatOwnerLeft**(`payload`): `ChatOwnerLeft`

Defined in: contexts/index.d.ts:2445

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatOwnerLeft`](../../../../gramio/interfaces/TelegramChatOwnerLeft.md) |

#### Returns

`ChatOwnerLeft`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatOwnerLeft`](../../../../gramio/interfaces/TelegramChatOwnerLeft.md) | contexts/index.d.ts:2444 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2447

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### newOwner

#### Get Signature

> **get** **newOwner**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2451

*Optional*. The user which will be the new owner of the chat if the previous owner does not return to the chat

##### Returns

[`User`](User.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatOwnerLeftContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatOwnerLeftContext

# Class: ChatOwnerLeftContext\<Bot>

Defined in: contexts/index.d.ts:5480

This object represents a service message about the chat owner leaving the chat.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ChatOwnerLeftContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ChatOwnerLeftContext`<`Bot`>, `ChatOwnerLeftContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChatOwnerLeftContext**<`Bot`>(`options`): `ChatOwnerLeftContext`<`Bot`>

Defined in: contexts/index.d.ts:5484

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ChatOwnerLeftContextOptions`<`Bot`> |

#### Returns

`ChatOwnerLeftContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ChatOwnerLeftContext**(...`args`): `ChatOwnerLeftContext`

Defined in: contexts/index.d.ts:5480

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ChatOwnerLeftContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5482 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:5486

Service message: chat owner left information

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### newOwner

#### Get Signature

> **get** **newOwner**(): [`User`](User.md)

Defined in: contexts/index.d.ts:5488

*Optional*. The user which will be the new owner of the chat if the previous owner does not return to the chat

##### Returns

[`User`](User.md)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `ChatOwnerLeftContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ChatOwnerLeftContextOptions` |

#### Returns

`ChatOwnerLeftContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChatOwnerLeftContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ChatOwnerLeftContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ChatOwnerLeftContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ChatOwnerLeftContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ChatOwnerLeftContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ChatOwnerLeftContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ChatOwnerLeftContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ChatOwnerLeftContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<ChatOwnerLeftContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ChatOwnerLeftContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ChatOwnerLeftContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ChatOwnerLeftContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatPermissions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatPermissions

# Class: ChatPermissions

Defined in: contexts/index.d.ts:3393

Describes actions that a non-administrator user is allowed to take in a chat.

[Documentation](https://core.telegram.org/bots/api/#chatpermissions)

## Constructors

### Constructor

> **new ChatPermissions**(`payload`): `ChatPermissions`

Defined in: contexts/index.d.ts:3395

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |

#### Returns

`ChatPermissions`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) | contexts/index.d.ts:3394 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3397

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### canAddWebPagePreviews

#### Get Signature

> **get** **canAddWebPagePreviews**(): `boolean`

Defined in: contexts/index.d.ts:3437

*Optional*. *True*, if the user is allowed to add web page previews to their messages

##### Returns

`boolean`

***

### canChangeInfo

#### Get Signature

> **get** **canChangeInfo**(): `boolean`

Defined in: contexts/index.d.ts:3441

*Optional*. *True*, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups

##### Returns

`boolean`

***

### canEditTag

#### Get Signature

> **get** **canEditTag**(): `boolean`

Defined in: contexts/index.d.ts:3455

*Optional*. *True*, if the user is allowed to edit their own tag

##### Returns

`boolean`

***

### canInviteUsers

#### Get Signature

> **get** **canInviteUsers**(): `boolean`

Defined in: contexts/index.d.ts:3445

*Optional*. *True*, if the user is allowed to invite new users to the chat

##### Returns

`boolean`

***

### canManageTopics

#### Get Signature

> **get** **canManageTopics**(): `boolean`

Defined in: contexts/index.d.ts:3453

*Optional*. *True*, if the user is allowed to create forum topics. If omitted defaults to the value of can\_pin\_messages

##### Returns

`boolean`

***

### canPinMessages

#### Get Signature

> **get** **canPinMessages**(): `boolean`

Defined in: contexts/index.d.ts:3449

*Optional*. *True*, if the user is allowed to pin messages. Ignored in public supergroups

##### Returns

`boolean`

***

### canSendAudios

#### Get Signature

> **get** **canSendAudios**(): `boolean`

Defined in: contexts/index.d.ts:3405

*Optional*. *True*, if the user is allowed to send audios

##### Returns

`boolean`

***

### canSendDocuments

#### Get Signature

> **get** **canSendDocuments**(): `boolean`

Defined in: contexts/index.d.ts:3409

*Optional*. *True*, if the user is allowed to send documents

##### Returns

`boolean`

***

### canSendMessages

#### Get Signature

> **get** **canSendMessages**(): `boolean`

Defined in: contexts/index.d.ts:3401

*Optional*. *True*, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues

##### Returns

`boolean`

***

### canSendOtherMessages

#### Get Signature

> **get** **canSendOtherMessages**(): `boolean`

Defined in: contexts/index.d.ts:3433

*Optional*. *True*, if the user is allowed to send animations, games, stickers and use inline bots

##### Returns

`boolean`

***

### canSendPhotos

#### Get Signature

> **get** **canSendPhotos**(): `boolean`

Defined in: contexts/index.d.ts:3413

*Optional*. *True*, if the user is allowed to send photos

##### Returns

`boolean`

***

### canSendPolls

#### Get Signature

> **get** **canSendPolls**(): `boolean`

Defined in: contexts/index.d.ts:3429

*Optional*. *True*, if the user is allowed to send polls

##### Returns

`boolean`

***

### canSendVideoNotes

#### Get Signature

> **get** **canSendVideoNotes**(): `boolean`

Defined in: contexts/index.d.ts:3421

*Optional*. *True*, if the user is allowed to send video notes

##### Returns

`boolean`

***

### canSendVideos

#### Get Signature

> **get** **canSendVideos**(): `boolean`

Defined in: contexts/index.d.ts:3417

*Optional*. *True*, if the user is allowed to send videos

##### Returns

`boolean`

***

### canSendVoiceNotes

#### Get Signature

> **get** **canSendVoiceNotes**(): `boolean`

Defined in: contexts/index.d.ts:3425

*Optional*. *True*, if the user is allowed to send voice notes

##### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatPhoto.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatPhoto

# Class: ChatPhoto

Defined in: contexts/index.d.ts:3459

This object represents a chat photo.

## Constructors

### Constructor

> **new ChatPhoto**(`payload`): `ChatPhoto`

Defined in: contexts/index.d.ts:3461

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatPhoto`](../../../../gramio/interfaces/TelegramChatPhoto.md) |

#### Returns

`ChatPhoto`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatPhoto`](../../../../gramio/interfaces/TelegramChatPhoto.md) | contexts/index.d.ts:3460 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3463

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### bigFileId

#### Get Signature

> **get** **bigFileId**(): `string`

Defined in: contexts/index.d.ts:3480

File identifier of big (`640x640`) chat photo. This `file_id` can be used
only for photo download and only for as long as the photo is not changed.

##### Returns

`string`

***

### bigFileUniqueId

#### Get Signature

> **get** **bigFileUniqueId**(): `string`

Defined in: contexts/index.d.ts:3486

Unique file identifier of big (`640x640`) chat photo, which is supposed
to be the same over time and for different bots. Can't be used to
download or reuse the file.

##### Returns

`string`

***

### smallFileId

#### Get Signature

> **get** **smallFileId**(): `string`

Defined in: contexts/index.d.ts:3469

File identifier of small (`160x160`) chat photo.
This `file_id` can be used only for photo download and only for as long
as the photo is not changed.

##### Returns

`string`

***

### smallFileUniqueId

#### Get Signature

> **get** **smallFileUniqueId**(): `string`

Defined in: contexts/index.d.ts:3475

Unique file identifier of small (`160x160`) chat photo, which is supposed
to be the same over time and for different bots. Can't be used to download
or reuse the file.

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatSenderControlMixin.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatSenderControlMixin

# Class: ChatSenderControlMixin\<Bot>

Defined in: contexts/index.d.ts:5146

This object is a mixin that does all the chat-sender stuff, right?

## Extends

* [`Context`](Context.md)<`Bot`>.[`TargetMixin`](TargetMixin.md)

## Extended by

* [`BoostAddedContext`](BoostAddedContext.md)
* [`ChatBackgroundSetContext`](ChatBackgroundSetContext.md)
* [`ChecklistTasksAddedContext`](ChecklistTasksAddedContext.md)
* [`ChecklistTasksDoneContext`](ChecklistTasksDoneContext.md)
* [`DeleteChatPhotoContext`](DeleteChatPhotoContext.md)
* [`DirectMessagePriceChangedContext`](DirectMessagePriceChangedContext.md)
* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)
* [`GroupChatCreatedContext`](GroupChatCreatedContext.md)
* [`LeftChatMemberContext`](LeftChatMemberContext.md)
* [`LocationContext`](LocationContext.md)
* [`MessageContext`](MessageContext.md)
* [`NewChatMembersContext`](NewChatMembersContext.md)
* [`NewChatPhotoContext`](NewChatPhotoContext.md)
* [`NewChatTitleContext`](NewChatTitleContext.md)
* [`PinnedMessageContext`](PinnedMessageContext.md)
* [`ProximityAlertTriggeredContext`](ProximityAlertTriggeredContext.md)
* [`VideoChatEndedContext`](VideoChatEndedContext.md)
* [`VideoChatParticipantsInvitedContext`](VideoChatParticipantsInvitedContext.md)
* [`VideoChatScheduledContext`](VideoChatScheduledContext.md)
* [`VideoChatStartedContext`](VideoChatStartedContext.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChatSenderControlMixin**<`Bot`>(): `ChatSenderControlMixin`<`Bot`>

#### Returns

`ChatSenderControlMixin`<`Bot`>

#### Inherited from

[`Context`](Context.md).[`constructor`](Context.md#constructor)

## Properties

| Property | Modifier | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | `Record`<`string`, `any`> | [`TargetMixin`](TargetMixin.md).[`payload`](TargetMixin.md#payload) | contexts/index.d.ts:4740 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4765

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`businessConnectionId`](TargetMixin.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4759

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chat`](TargetMixin.md#chat)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4744

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`from`](TargetMixin.md#from)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:4757

*Optional*. If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderBoostCount`](TargetMixin.md#senderboostcount)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4753

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderChat`](TargetMixin.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

***

### hasFrom()

> **hasFrom**(): this is Require\<ChatSenderControlMixin\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ChatSenderControlMixin\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ChatSenderControlMixin<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ChatSenderControlMixin<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ChatSenderControlMixin<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ChatSenderControlMixin<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ChatSenderControlMixin<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ChatSenderControlMixin<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPM()

> **isPM**(): `this is RequireValue<ChatSenderControlMixin<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ChatSenderControlMixin<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ChatSenderControlMixin<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ChatSenderControlMixin<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatShared.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatShared

# Class: ChatShared

Defined in: contexts/index.d.ts:1442

This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button.

## Constructors

### Constructor

> **new ChatShared**(`payload`): `ChatShared`

Defined in: contexts/index.d.ts:1444

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChatShared`](../../../../gramio/interfaces/TelegramChatShared.md) |

#### Returns

`ChatShared`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChatShared`](../../../../gramio/interfaces/TelegramChatShared.md) | contexts/index.d.ts:1443 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1446

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:1450

Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.

##### Returns

`number`

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:1456

Available sizes of the chat photo, if the photo was requested by the bot.

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

***

### requestId

#### Get Signature

> **get** **requestId**(): `number`

Defined in: contexts/index.d.ts:1448

Identifier of the request

##### Returns

`number`

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:1452

Title of the chat, if the title was requested by the bot.

##### Returns

`string`

***

### username

#### Get Signature

> **get** **username**(): `string`

Defined in: contexts/index.d.ts:1454

Username of the chat, if the username was requested by the bot and available.

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChatSharedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatSharedContext

# Class: ChatSharedContext\<Bot>

Defined in: contexts/index.d.ts:5522

This object contains information about the chat whose identifier was shared with the bot using a `KeyboardButtonRequestChat` button.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ChatSharedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ChatSharedContext`<`Bot`>, `ChatSharedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChatSharedContext**<`Bot`>(`options`): `ChatSharedContext`<`Bot`>

Defined in: contexts/index.d.ts:5526

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ChatSharedContextOptions`<`Bot`> |

#### Returns

`ChatSharedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ChatSharedContext**(...`args`): `ChatSharedContext`

Defined in: contexts/index.d.ts:5522

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ChatSharedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5524 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:5536

Available sizes of the chat photo, if the photo was requested by the bot.

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### requestId

#### Get Signature

> **get** **requestId**(): `number`

Defined in: contexts/index.d.ts:5528

Identifier of the request

##### Returns

`number`

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sharedChatId

#### Get Signature

> **get** **sharedChatId**(): `number`

Defined in: contexts/index.d.ts:5530

Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.

##### Returns

`number`

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:5532

Title of the chat, if the title was requested by the bot.

##### Returns

`string`

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### username

#### Get Signature

> **get** **username**(): `string`

Defined in: contexts/index.d.ts:5534

Username of the chat, if the username was requested by the bot and available.

##### Returns

`string`

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `ChatSharedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ChatSharedContextOptions` |

#### Returns

`ChatSharedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChatSharedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ChatSharedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ChatSharedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ChatSharedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ChatSharedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ChatSharedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ChatSharedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ChatSharedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<ChatSharedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ChatSharedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ChatSharedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ChatSharedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/Checklist.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Checklist

# Class: Checklist

Defined in: contexts/index.d.ts:1516

Describes a checklist.

[Documentation](https://core.telegram.org/bots/api/#checklist)

## Constructors

### Constructor

> **new Checklist**(`payload`): `Checklist`

Defined in: contexts/index.d.ts:1518

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChecklist`](../../../../gramio/interfaces/TelegramChecklist.md) |

#### Returns

`Checklist`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChecklist`](../../../../gramio/interfaces/TelegramChecklist.md) | contexts/index.d.ts:1517 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1519

##### Returns

`string`

***

### othersCanAddTasks

#### Get Signature

> **get** **othersCanAddTasks**(): `true`

Defined in: contexts/index.d.ts:1535

*Optional*. *True*, if users other than the creator of the list can add tasks to the list

##### Returns

`true`

***

### othersCanMarkTasksAsDone

#### Get Signature

> **get** **othersCanMarkTasksAsDone**(): `true`

Defined in: contexts/index.d.ts:1539

*Optional*. *True*, if users other than the creator of the list can mark tasks as done or not done

##### Returns

`true`

***

### tasks

#### Get Signature

> **get** **tasks**(): [`ChecklistTask`](ChecklistTask.md)\[]

Defined in: contexts/index.d.ts:1531

List of tasks in the checklist

##### Returns

[`ChecklistTask`](ChecklistTask.md)\[]

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:1523

Title of the checklist

##### Returns

`string`

***

### titleEntities

#### Get Signature

> **get** **titleEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:1527

*Optional*. Special entities that appear in the checklist title

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

---

---
url: 'https://gramio.dev/api/contexts/classes/ChecklistTask.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChecklistTask

# Class: ChecklistTask

Defined in: contexts/index.d.ts:1481

Describes a task in a checklist.

[Documentation](https://core.telegram.org/bots/api/#checklisttask)

## Constructors

### Constructor

> **new ChecklistTask**(`payload`): `ChecklistTask`

Defined in: contexts/index.d.ts:1483

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChecklistTask`](../../../../gramio/interfaces/TelegramChecklistTask.md) |

#### Returns

`ChecklistTask`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChecklistTask`](../../../../gramio/interfaces/TelegramChecklistTask.md) | contexts/index.d.ts:1482 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1484

##### Returns

`string`

***

### completedByChat

#### Get Signature

> **get** **completedByChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:1504

*Optional*. Chat that completed the task; omitted if the task wasn't completed by a chat

##### Returns

[`Chat`](Chat.md)

***

### completedByUser

#### Get Signature

> **get** **completedByUser**(): [`User`](User.md)

Defined in: contexts/index.d.ts:1500

*Optional*. User that completed the task; omitted if the task wasn't completed

##### Returns

[`User`](User.md)

***

### completionDate

#### Get Signature

> **get** **completionDate**(): `Date`

Defined in: contexts/index.d.ts:1508

*Optional*. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed

##### Returns

`Date`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:1488

Unique identifier of the task

##### Returns

`number`

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:1492

Text of the task

##### Returns

`string`

***

### textEntities

#### Get Signature

> **get** **textEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:1496

*Optional*. Special entities that appear in the task text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

---

---
url: 'https://gramio.dev/api/contexts/classes/ChecklistTasksAdded.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChecklistTasksAdded

# Class: ChecklistTasksAdded

Defined in: contexts/index.d.ts:2459

Describes a service message about tasks added to a checklist.

[Documentation](https://core.telegram.org/bots/api/#checklisttasksadded)

## Constructors

### Constructor

> **new ChecklistTasksAdded**(`payload`): `ChecklistTasksAdded`

Defined in: contexts/index.d.ts:2461

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChecklistTasksAdded`](../../../../gramio/interfaces/TelegramChecklistTasksAdded.md) |

#### Returns

`ChecklistTasksAdded`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChecklistTasksAdded`](../../../../gramio/interfaces/TelegramChecklistTasksAdded.md) | contexts/index.d.ts:2460 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2462

##### Returns

`string`

***

### checklistMessage

#### Get Signature

> **get** **checklistMessage**(): [`Message`](Message.md)

Defined in: contexts/index.d.ts:2466

*Optional*. Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the *reply\_to\_message* field even if it itself is a reply.

##### Returns

[`Message`](Message.md)

***

### tasks

#### Get Signature

> **get** **tasks**(): [`TelegramChecklistTask`](../../../../gramio/interfaces/TelegramChecklistTask.md)\[]

Defined in: contexts/index.d.ts:2470

List of tasks added to the checklist

##### Returns

[`TelegramChecklistTask`](../../../../gramio/interfaces/TelegramChecklistTask.md)\[]

---

---
url: 'https://gramio.dev/api/contexts/classes/ChecklistTasksAddedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChecklistTasksAddedContext

# Class: ChecklistTasksAddedContext\<Bot>

Defined in: contexts/index.d.ts:5576

This object represents a service message about checklist tasks added.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ChecklistTasksAddedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ChecklistTasksAddedContext`<`Bot`>, `ChecklistTasksAddedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChecklistTasksAddedContext**<`Bot`>(`options`): `ChecklistTasksAddedContext`<`Bot`>

Defined in: contexts/index.d.ts:5580

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ChecklistTasksAddedContextOptions`<`Bot`> |

#### Returns

`ChecklistTasksAddedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ChecklistTasksAddedContext**(...`args`): `ChecklistTasksAddedContext`

Defined in: contexts/index.d.ts:5576

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ChecklistTasksAddedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `event` | `public` | [`TelegramChecklistTasksAdded`](../../../../gramio/interfaces/TelegramChecklistTasksAdded.md) | - | - | contexts/index.d.ts:5579 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5578 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistMessage

#### Get Signature

> **get** **checklistMessage**(): [`Message`](Message.md)

Defined in: contexts/index.d.ts:5584

*Optional*. Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the *reply\_to\_message* field even if it itself is a reply.

##### Returns

[`Message`](Message.md)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### tasks

#### Get Signature

> **get** **tasks**(): [`ChecklistTask`](ChecklistTask.md)\[]

Defined in: contexts/index.d.ts:5588

List of tasks added to the checklist

##### Returns

[`ChecklistTask`](ChecklistTask.md)\[]

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `ChecklistTasksAddedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ChecklistTasksAddedContextOptions` |

#### Returns

`ChecklistTasksAddedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChecklistTasksAddedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ChecklistTasksAddedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ChecklistTasksAddedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ChecklistTasksAddedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ChecklistTasksAddedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ChecklistTasksAddedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ChecklistTasksAddedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ChecklistTasksAddedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<ChecklistTasksAddedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ChecklistTasksAddedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ChecklistTasksAddedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ChecklistTasksAddedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChecklistTasksDone.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChecklistTasksDone

# Class: ChecklistTasksDone

Defined in: contexts/index.d.ts:2478

Describes a service message about checklist tasks marked as done or not done.

[Documentation](https://core.telegram.org/bots/api/#checklisttasksdone)

## Constructors

### Constructor

> **new ChecklistTasksDone**(`payload`): `ChecklistTasksDone`

Defined in: contexts/index.d.ts:2480

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChecklistTasksDone`](../../../../gramio/interfaces/TelegramChecklistTasksDone.md) |

#### Returns

`ChecklistTasksDone`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChecklistTasksDone`](../../../../gramio/interfaces/TelegramChecklistTasksDone.md) | contexts/index.d.ts:2479 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2481

##### Returns

`string`

***

### checklistMessage

#### Get Signature

> **get** **checklistMessage**(): [`Message`](Message.md)

Defined in: contexts/index.d.ts:2485

*Optional*. Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the *reply\_to\_message* field even if it itself is a reply.

##### Returns

[`Message`](Message.md)

***

### markedAsDoneTaskIds

#### Get Signature

> **get** **markedAsDoneTaskIds**(): `number`\[]

Defined in: contexts/index.d.ts:2489

*Optional*. Identifiers of the tasks that were marked as done

##### Returns

`number`\[]

***

### markedAsNotDoneTaskIds

#### Get Signature

> **get** **markedAsNotDoneTaskIds**(): `number`\[]

Defined in: contexts/index.d.ts:2493

*Optional*. Identifiers of the tasks that were marked as not done

##### Returns

`number`\[]

---

---
url: 'https://gramio.dev/api/contexts/classes/ChecklistTasksDoneContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChecklistTasksDoneContext

# Class: ChecklistTasksDoneContext\<Bot>

Defined in: contexts/index.d.ts:5548

This object represents a service message about checklist tasks done.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ChecklistTasksDoneContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ChecklistTasksDoneContext`<`Bot`>, `ChecklistTasksDoneContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChecklistTasksDoneContext**<`Bot`>(`options`): `ChecklistTasksDoneContext`<`Bot`>

Defined in: contexts/index.d.ts:5552

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ChecklistTasksDoneContextOptions`<`Bot`> |

#### Returns

`ChecklistTasksDoneContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ChecklistTasksDoneContext**(...`args`): `ChecklistTasksDoneContext`

Defined in: contexts/index.d.ts:5548

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ChecklistTasksDoneContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `event` | `public` | [`TelegramChecklistTasksDone`](../../../../gramio/interfaces/TelegramChecklistTasksDone.md) | - | - | contexts/index.d.ts:5551 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5550 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistMessage

#### Get Signature

> **get** **checklistMessage**(): [`Message`](Message.md)

Defined in: contexts/index.d.ts:5556

*Optional*. Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the *reply\_to\_message* field even if it itself is a reply.

##### Returns

[`Message`](Message.md)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### markedAsDoneTaskIds

#### Get Signature

> **get** **markedAsDoneTaskIds**(): `number`\[]

Defined in: contexts/index.d.ts:5560

*Optional*. Identifiers of the tasks that were marked as done

##### Returns

`number`\[]

***

### markedAsNotDoneTaskIds

#### Get Signature

> **get** **markedAsNotDoneTaskIds**(): `number`\[]

Defined in: contexts/index.d.ts:5564

*Optional*. Identifiers of the tasks that were marked as not done

##### Returns

`number`\[]

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `ChecklistTasksDoneContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ChecklistTasksDoneContextOptions` |

#### Returns

`ChecklistTasksDoneContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChecklistTasksDoneContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ChecklistTasksDoneContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ChecklistTasksDoneContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ChecklistTasksDoneContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ChecklistTasksDoneContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ChecklistTasksDoneContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ChecklistTasksDoneContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ChecklistTasksDoneContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<ChecklistTasksDoneContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ChecklistTasksDoneContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ChecklistTasksDoneContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ChecklistTasksDoneContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ChosenInlineResult.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChosenInlineResult

# Class: ChosenInlineResult

Defined in: contexts/index.d.ts:3976

Represents a result of an inline query that was chosen by the user and sent to their chat partner.

## Extended by

* [`ChosenInlineResultContext`](ChosenInlineResultContext.md)

## Constructors

### Constructor

> **new ChosenInlineResult**(`payload`): `ChosenInlineResult`

Defined in: contexts/index.d.ts:3978

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramChosenInlineResult`](../../../../gramio/interfaces/TelegramChosenInlineResult.md) |

#### Returns

`ChosenInlineResult`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramChosenInlineResult`](../../../../gramio/interfaces/TelegramChosenInlineResult.md) | contexts/index.d.ts:3977 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3980

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3984

The user that chose the result

##### Returns

[`User`](User.md)

***

### inlineMessageId

#### Get Signature

> **get** **inlineMessageId**(): `string`

Defined in: contexts/index.d.ts:3994

Identifier of the sent inline message. Available only if there is an
inline keyboard attached to the message. Will be also received in callback
queries and can be used to edit the message.

##### Returns

`string`

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3988

Sender location, only for bots that require user location

##### Returns

[`Location`](Location.md)

***

### query

#### Get Signature

> **get** **query**(): `string`

Defined in: contexts/index.d.ts:3996

The query that was used to obtain the result

##### Returns

`string`

***

### resultId

#### Get Signature

> **get** **resultId**(): `string`

Defined in: contexts/index.d.ts:3982

The unique identifier for the result that was chosen

##### Returns

`string`

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:3986

Sender ID

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/ChosenInlineResultContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChosenInlineResultContext

# Class: ChosenInlineResultContext\<Bot>

Defined in: contexts/index.d.ts:5603

The result of an inline query that was chosen by
a user and sent to their chat partner

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ChosenInlineResultContext`<`Bot`>>.[`ChosenInlineResult`](ChosenInlineResult.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ChosenInlineResultContext`<`Bot`>, `ChosenInlineResultContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ChosenInlineResultContext**<`Bot`>(`options`): `ChosenInlineResultContext`<`Bot`>

Defined in: contexts/index.d.ts:5606

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ChosenInlineResultContextOptions`<`Bot`> |

#### Returns

`ChosenInlineResultContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ChosenInlineResultContext**(...`args`): `ChosenInlineResultContext`

Defined in: contexts/index.d.ts:5603

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ChosenInlineResultContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | [`TelegramChosenInlineResult`](../../../../gramio/interfaces/TelegramChosenInlineResult.md) | The raw data that is used for this Context | [`ChosenInlineResult`](ChosenInlineResult.md).[`payload`](ChosenInlineResult.md#payload) | contexts/index.d.ts:5605 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4859

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3984

The user that chose the result

##### Returns

[`User`](User.md)

#### Inherited from

[`ChosenInlineResult`](ChosenInlineResult.md).[`from`](ChosenInlineResult.md#from)

***

### inlineMessageId

#### Get Signature

> **get** **inlineMessageId**(): `string`

Defined in: contexts/index.d.ts:3994

Identifier of the sent inline message. Available only if there is an
inline keyboard attached to the message. Will be also received in callback
queries and can be used to edit the message.

##### Returns

`string`

#### Inherited from

[`ChosenInlineResult`](ChosenInlineResult.md).[`inlineMessageId`](ChosenInlineResult.md#inlinemessageid)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3988

Sender location, only for bots that require user location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`ChosenInlineResult`](ChosenInlineResult.md).[`location`](ChosenInlineResult.md#location)

***

### query

#### Get Signature

> **get** **query**(): `string`

Defined in: contexts/index.d.ts:3996

The query that was used to obtain the result

##### Returns

`string`

#### Inherited from

[`ChosenInlineResult`](ChosenInlineResult.md).[`query`](ChosenInlineResult.md#query)

***

### resultId

#### Get Signature

> **get** **resultId**(): `string`

Defined in: contexts/index.d.ts:3982

The unique identifier for the result that was chosen

##### Returns

`string`

#### Inherited from

[`ChosenInlineResult`](ChosenInlineResult.md).[`resultId`](ChosenInlineResult.md#resultid)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:3986

Sender ID

##### Returns

`number`

#### Inherited from

[`ChosenInlineResult`](ChosenInlineResult.md).[`senderId`](ChosenInlineResult.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### clone()

> **clone**(`options?`): `ChosenInlineResultContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ChosenInlineResultContextOptions` |

#### Returns

`ChosenInlineResultContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)>

Defined in: contexts/index.d.ts:5614

Edits a callback query messages caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)>

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)>

Defined in: contexts/index.d.ts:5618

Edits a callback query messages live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)>

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)>

Defined in: contexts/index.d.ts:5616

Edits a callback query messages media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)>

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)>

Defined in: contexts/index.d.ts:5622

Edits a callback query messages reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)>

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)>

Defined in: contexts/index.d.ts:5612

Edits a callback query messages text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)>

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasInlineMessageId()

> **hasInlineMessageId**(): `this is Require<ChosenInlineResultContext<Bot>, "inlineMessageId">`

Defined in: contexts/index.d.ts:5610

Checks if the query has `inlineMessageId` property

#### Returns

`this is Require<ChosenInlineResultContext<Bot>, "inlineMessageId">`

***

### hasLocation()

> **hasLocation**(): `this is Require<ChosenInlineResultContext<Bot>, "location">`

Defined in: contexts/index.d.ts:5608

Checks if the result has `location` property

#### Returns

`this is Require<ChosenInlineResultContext<Bot>, "location">`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)>

Defined in: contexts/index.d.ts:5620

Stops a callback query messages live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md)>

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/CloneMixin.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / CloneMixin

# Class: CloneMixin\<Bot, C, Options>

Defined in: contexts/index.d.ts:5272

This object represents a mixin which has `clone(options?)` method

## Extends

* [`Context`](Context.md)<`Bot`>.`CloneMixinMetadata`<`Options`\[`"payload"`]>

## Extended by

* [`BoostAddedContext`](BoostAddedContext.md)
* [`BusinessConnectionContext`](BusinessConnectionContext.md)
* [`BusinessMessagesDeletedContext`](BusinessMessagesDeletedContext.md)
* [`CallbackQueryContext`](CallbackQueryContext.md)
* [`ChatBackgroundSetContext`](ChatBackgroundSetContext.md)
* [`ChatBoostContext`](ChatBoostContext.md)
* [`ChatJoinRequestContext`](ChatJoinRequestContext.md)
* [`ChatMemberContext`](ChatMemberContext.md)
* [`ChatOwnerChangedContext`](ChatOwnerChangedContext.md)
* [`ChatOwnerLeftContext`](ChatOwnerLeftContext.md)
* [`ChatSharedContext`](ChatSharedContext.md)
* [`ChecklistTasksAddedContext`](ChecklistTasksAddedContext.md)
* [`ChecklistTasksDoneContext`](ChecklistTasksDoneContext.md)
* [`ChosenInlineResultContext`](ChosenInlineResultContext.md)
* [`DeleteChatPhotoContext`](DeleteChatPhotoContext.md)
* [`DirectMessagePriceChangedContext`](DirectMessagePriceChangedContext.md)
* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiftContext`](GiftContext.md)
* [`GiftUpgradeSentContext`](GiftUpgradeSentContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)
* [`GroupChatCreatedContext`](GroupChatCreatedContext.md)
* [`InlineQueryContext`](InlineQueryContext.md)
* [`InvoiceContext`](InvoiceContext.md)
* [`LeftChatMemberContext`](LeftChatMemberContext.md)
* [`LocationContext`](LocationContext.md)
* [`MessageAutoDeleteTimerChangedContext`](MessageAutoDeleteTimerChangedContext.md)
* [`MessageContext`](MessageContext.md)
* [`MessageReactionContext`](MessageReactionContext.md)
* [`MessageReactionCountContext`](MessageReactionCountContext.md)
* [`MigrateFromChatIdContext`](MigrateFromChatIdContext.md)
* [`MigrateToChatIdContext`](MigrateToChatIdContext.md)
* [`NewChatMembersContext`](NewChatMembersContext.md)
* [`NewChatPhotoContext`](NewChatPhotoContext.md)
* [`NewChatTitleContext`](NewChatTitleContext.md)
* [`PaidMediaPurchasedContext`](PaidMediaPurchasedContext.md)
* [`PaidMessagePriceChangedContext`](PaidMessagePriceChangedContext.md)
* [`PassportDataContext`](PassportDataContext.md)
* [`PinnedMessageContext`](PinnedMessageContext.md)
* [`PollAnswerContext`](PollAnswerContext.md)
* [`PollContext`](PollContext.md)
* [`PreCheckoutQueryContext`](PreCheckoutQueryContext.md)
* [`ProximityAlertTriggeredContext`](ProximityAlertTriggeredContext.md)
* [`RefundedPaymentContext`](RefundedPaymentContext.md)
* [`RemovedChatBoostContext`](RemovedChatBoostContext.md)
* [`ShippingQueryContext`](ShippingQueryContext.md)
* [`SuccessfulPaymentContext`](SuccessfulPaymentContext.md)
* [`SuggestedPostApprovalFailedContext`](SuggestedPostApprovalFailedContext.md)
* [`SuggestedPostApprovedContext`](SuggestedPostApprovedContext.md)
* [`SuggestedPostDeclinedContext`](SuggestedPostDeclinedContext.md)
* [`SuggestedPostPaidContext`](SuggestedPostPaidContext.md)
* [`SuggestedPostRefundedContext`](SuggestedPostRefundedContext.md)
* [`UniqueGiftContext`](UniqueGiftContext.md)
* [`UsersSharedContext`](UsersSharedContext.md)
* [`VideoChatEndedContext`](VideoChatEndedContext.md)
* [`VideoChatParticipantsInvitedContext`](VideoChatParticipantsInvitedContext.md)
* [`VideoChatScheduledContext`](VideoChatScheduledContext.md)
* [`VideoChatStartedContext`](VideoChatStartedContext.md)
* [`WebAppDataContext`](WebAppDataContext.md)
* [`WriteAccessAllowedContext`](WriteAccessAllowedContext.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |
| `C` *extends* [`Context`](Context.md)<`Bot`> & [`Constructor`](../type-aliases/Constructor.md)<`C`> |
| `Options` *extends* `Record`<`string`, `any`> |

## Constructors

### Constructor

> **new CloneMixin**<`Bot`, `C`, `Options`>(): `CloneMixin`<`Bot`, `C`, `Options`>

#### Returns

`CloneMixin`<`Bot`, `C`, `Options`>

#### Inherited from

[`Context`](Context.md).[`constructor`](Context.md#constructor)

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | `Options`\[`"payload"`] | The raw data that is used for this Context | - | contexts/index.d.ts:5269 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

## Methods

### clone()

> **clone**(`options?`): `C`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `Options` |

#### Returns

`C`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

---

---
url: 'https://gramio.dev/api/composer/classes/Composer.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / Composer

# Class: Composer\<TIn, TOut, TExposed, TMacros>

Defined in: composer/index.d.ts:143

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `TIn` *extends* `object` | `object` |
| `TOut` *extends* `TIn` | `TIn` |
| `TExposed` *extends* `object` | `object` |
| `TMacros` *extends* [`MacroDefinitions`](../type-aliases/MacroDefinitions.md) | `object` |

## Constructors

### Constructor

> **new Composer**<`TIn`, `TOut`, `TExposed`, `TMacros`>(`options?`): `Composer`<`TIn`, `TOut`, `TExposed`, `TMacros`>

Defined in: composer/index.d.ts:160

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ComposerOptions`](../interfaces/ComposerOptions.md) |

#### Returns

`Composer`<`TIn`, `TOut`, `TExposed`, `TMacros`>

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `~` | `object` | - | composer/index.d.ts:144 |
| `~.compiled` | [`ComposedMiddleware`](../type-aliases/ComposedMiddleware.md)<`any`> | - | composer/index.d.ts:148 |
| `~.errorsDefinitions` | `Record`<`string`, {(...`args`): `any`; `prototype`: `Error`; }> | - | composer/index.d.ts:151 |
| `~.extended` | `Set`<`string`> | - | composer/index.d.ts:147 |
| `~.macros` | `Record`<`string`, [`MacroDef`](../type-aliases/MacroDef.md)<`any`, `any`>> | - | composer/index.d.ts:156 |
| `~.middlewares` | `ScopedMiddleware`<`any`>\[] | - | composer/index.d.ts:145 |
| `~.name` | `string` | - | composer/index.d.ts:149 |
| `~.onErrors` | [`ErrorHandler`](../type-aliases/ErrorHandler.md)<`any`>\[] | - | composer/index.d.ts:146 |
| `~.Out` | `TOut` | Phantom type accessor — never set at runtime, used by `ContextOf<T>` | composer/index.d.ts:158 |
| `~.seed` | `unknown` | - | composer/index.d.ts:150 |
| `~.tracer` | [`TraceHandler`](../type-aliases/TraceHandler.md) | - | composer/index.d.ts:155 |

## Methods

### as()

> **as**(`scope`): `Composer`<`TIn`, `TOut`, `TOut`>

Defined in: composer/index.d.ts:190

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `scope` | `"global"` | `"scoped"` |

#### Returns

`Composer`<`TIn`, `TOut`, `TOut`>

***

### branch()

> **branch**(`predicate`, `onTrue`, `onFalse?`): `Composer`<`TIn`, `TOut`, `TExposed`>

Defined in: composer/index.d.ts:178

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `predicate` | `boolean` | (`context`) => `boolean` | `Promise`<`boolean`> |
| `onTrue` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`> |
| `onFalse?` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`> |

#### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

***

### compose()

> **compose**(): [`ComposedMiddleware`](../type-aliases/ComposedMiddleware.md)<`TIn`>

Defined in: composer/index.d.ts:195

#### Returns

[`ComposedMiddleware`](../type-aliases/ComposedMiddleware.md)<`TIn`>

***

### decorate()

#### Call Signature

> **decorate**<`D`>(`values`): `Composer`<`TIn`, `TOut` & `D`, `TExposed`>

Defined in: composer/index.d.ts:166

##### Type Parameters

| Type Parameter |
| ------ |
| `D` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `values` | `D` |

##### Returns

`Composer`<`TIn`, `TOut` & `D`, `TExposed`>

#### Call Signature

> **decorate**<`D`>(`values`, `options`): `Composer`<`TIn`, `TOut` & `D`, `TExposed` & `D`>

Defined in: composer/index.d.ts:167

##### Type Parameters

| Type Parameter |
| ------ |
| `D` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `values` | `D` |
| `options` | { `as`: `"global"` | `"scoped"`; } |
| `options.as` | `"global"` | `"scoped"` |

##### Returns

`Composer`<`TIn`, `TOut` & `D`, `TExposed` & `D`>

***

### derive()

#### Call Signature

> **derive**<`D`>(`handler`): `Composer`<`TIn`, `TOut` & `D`, `TExposed`>

Defined in: composer/index.d.ts:173

##### Type Parameters

| Type Parameter |
| ------ |
| `D` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`DeriveHandler`](../type-aliases/DeriveHandler.md)<`TOut`, `D`> |

##### Returns

`Composer`<`TIn`, `TOut` & `D`, `TExposed`>

#### Call Signature

> **derive**<`D`>(`handler`, `options`): `Composer`<`TIn`, `TOut` & `D`, `TExposed` & `D`>

Defined in: composer/index.d.ts:174

##### Type Parameters

| Type Parameter |
| ------ |
| `D` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`DeriveHandler`](../type-aliases/DeriveHandler.md)<`TOut`, `D`> |
| `options` | { `as`: `"global"` | `"scoped"`; } |
| `options.as` | `"global"` | `"scoped"` |

##### Returns

`Composer`<`TIn`, `TOut` & `D`, `TExposed` & `D`>

***

### error()

> **error**(`kind`, `errorClass`): `this`

Defined in: composer/index.d.ts:186

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `kind` | `string` |
| `errorClass` | {(...`args`): `any`; `prototype`: `Error`; } |
| `errorClass.prototype` | `Error` |

#### Returns

`this`

***

### extend()

> **extend**<`UIn`, `UOut`, `UExposed`, `UMacros`>(`other`): `Composer`<`TIn`, `TOut` & `UExposed`, `TExposed`, `TMacros` & `UMacros`>

Defined in: composer/index.d.ts:192

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `UIn` *extends* `object` | - |
| `UOut` *extends* `object` | - |
| `UExposed` *extends* `object` | - |
| `UMacros` *extends* [`MacroDefinitions`](../type-aliases/MacroDefinitions.md) | `object` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `other` | `Composer`<`UIn`, `UOut`, `UExposed`, `UMacros`> |

#### Returns

`Composer`<`TIn`, `TOut` & `UExposed`, `TExposed`, `TMacros` & `UMacros`>

***

### fork()

> **fork**(...`middleware`): `Composer`<`TIn`, `TOut`, `TExposed`>

Defined in: composer/index.d.ts:181

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`middleware` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`>\[] |

#### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

***

### group()

> **group**(`fn`): `Composer`<`TIn`, `TOut`, `TExposed`>

Defined in: composer/index.d.ts:191

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `fn` | (`composer`) => `void` |

#### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

***

### guard()

> **guard**<`S`>(`predicate`, ...`middleware`): `Composer`<`TIn`, `TOut`, `TExposed`>

Defined in: composer/index.d.ts:177

#### Type Parameters

| Type Parameter |
| ------ |
| `S` *extends* `object` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `predicate` | (`context`) => `context is S` | (`context`) => `boolean` | `Promise`<`boolean`> |
| ...`middleware` | [`Middleware`](../type-aliases/Middleware.md)<`any`>\[] |

#### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

***

### inspect()

> **inspect**(): [`MiddlewareInfo`](../interfaces/MiddlewareInfo.md)\[]

Defined in: composer/index.d.ts:193

#### Returns

[`MiddlewareInfo`](../interfaces/MiddlewareInfo.md)\[]

***

### invalidate()

> **invalidate**(): `void`

Defined in: composer/index.d.ts:161

#### Returns

`void`

***

### lazy()

> **lazy**(`factory`): `Composer`<`TIn`, `TOut`, `TExposed`>

Defined in: composer/index.d.ts:183

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `factory` | [`LazyFactory`](../type-aliases/LazyFactory.md)<`TOut`> |

#### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

***

### macro()

#### Call Signature

> **macro**<`Name`, `TDef`>(`name`, `definition`): `Composer`<`TIn`, `TOut`, `TExposed`, `TMacros` & `Record`<`Name`, `TDef`>>

Defined in: composer/index.d.ts:163

Register a single named macro

##### Type Parameters

| Type Parameter |
| ------ |
| `Name` *extends* `string` |
| `TDef` *extends* [`MacroDef`](../type-aliases/MacroDef.md)<`any`, `any`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `Name` |
| `definition` | `TDef` |

##### Returns

`Composer`<`TIn`, `TOut`, `TExposed`, `TMacros` & `Record`<`Name`, `TDef`>>

#### Call Signature

> **macro**<`TDefs`>(`definitions`): `Composer`<`TIn`, `TOut`, `TExposed`, `TMacros` & `TDefs`>

Defined in: composer/index.d.ts:165

Register multiple macros at once

##### Type Parameters

| Type Parameter |
| ------ |
| `TDefs` *extends* `Record`<`string`, [`MacroDef`](../type-aliases/MacroDef.md)<`any`, `any`>> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `definitions` | `TDefs` |

##### Returns

`Composer`<`TIn`, `TOut`, `TExposed`, `TMacros` & `TDefs`>

***

### onError()

> **onError**(`handler`): `Composer`<`TIn`, `TOut`, `TExposed`>

Defined in: composer/index.d.ts:184

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`ErrorHandler`](../type-aliases/ErrorHandler.md)<`TOut`> |

#### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

***

### route()

#### Call Signature

> **route**<`K`>(`router`, `builder`): `Composer`<`TIn`, `TOut`, `TExposed`>

Defined in: composer/index.d.ts:179

##### Type Parameters

| Type Parameter |
| ------ |
| `K` *extends* `string` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `router` | (`context`) => `K` | `Promise`<`K`> |
| `builder` | (`route`) => `void` |

##### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

#### Call Signature

> **route**<`K`>(`router`, `cases`, `fallback?`): `Composer`<`TIn`, `TOut`, `TExposed`>

Defined in: composer/index.d.ts:180

##### Type Parameters

| Type Parameter |
| ------ |
| `K` *extends* `string` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `router` | (`context`) => `K` | `Promise`<`K`> |
| `cases` | `Partial`<`Record`<`K`, [`Middleware`](../type-aliases/Middleware.md)<`TOut`> | [`Middleware`](../type-aliases/Middleware.md)<`TOut`>\[] | `Composer`<`any`, `any`, `any`>>> |
| `fallback?` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`> | [`Middleware`](../type-aliases/Middleware.md)<`TOut`>\[] | `Composer`<`any`, `any`, `any`, { }> |

##### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

***

### run()

> **run**(`context`, `next?`): `Promise`<`void`>

Defined in: composer/index.d.ts:196

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | `TIn` |
| `next?` | [`Next`](../type-aliases/Next.md) |

#### Returns

`Promise`<`void`>

***

### tap()

> **tap**(...`middleware`): `Composer`<`TIn`, `TOut`, `TExposed`>

Defined in: composer/index.d.ts:182

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`middleware` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`>\[] |

#### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

***

### trace()

> **trace**(`handler`): `this`

Defined in: composer/index.d.ts:194

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`TraceHandler`](../type-aliases/TraceHandler.md) |

#### Returns

`this`

***

### use()

#### Call Signature

> **use**(`handler`): `this`

Defined in: composer/index.d.ts:170

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`> |

##### Returns

`this`

#### Call Signature

> **use**<`Patch`>(`handler`): `this`

Defined in: composer/index.d.ts:171

##### Type Parameters

| Type Parameter |
| ------ |
| `Patch` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`Middleware`](../type-aliases/Middleware.md)<`TOut` & `Patch`> |

##### Returns

`this`

#### Call Signature

> **use**(...`middleware`): `Composer`<`TIn`, `TOut`, `TExposed`>

Defined in: composer/index.d.ts:172

##### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`middleware` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`>\[] |

##### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

***

### when()

> **when**<`UOut`>(`condition`, `fn`): `Composer`<`TIn`, `TOut` & `Partial`<`Omit`<`UOut`, keyof `TOut`>>, `TExposed`>

Defined in: composer/index.d.ts:185

#### Type Parameters

| Type Parameter |
| ------ |
| `UOut` *extends* `object` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `condition` | `boolean` |
| `fn` | (`composer`) => `Composer`<`TOut`, `UOut`, `any`> |

#### Returns

`Composer`<`TIn`, `TOut` & `Partial`<`Omit`<`UOut`, keyof `TOut`>>, `TExposed`>

---

---
url: 'https://gramio.dev/api/contexts/classes/Contact.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Contact

# Class: Contact

Defined in: contexts/index.d.ts:382

This object represents a phone contact.

## Extended by

* [`ContactAttachment`](ContactAttachment.md)

## Constructors

### Constructor

> **new Contact**(`payload`): `Contact`

Defined in: contexts/index.d.ts:384

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramContact`](../../../../gramio/interfaces/TelegramContact.md) |

#### Returns

`Contact`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramContact`](../../../../gramio/interfaces/TelegramContact.md) | contexts/index.d.ts:383 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:386

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### firstName

#### Get Signature

> **get** **firstName**(): `string`

Defined in: contexts/index.d.ts:390

Contact's first name

##### Returns

`string`

***

### lastName

#### Get Signature

> **get** **lastName**(): `string`

Defined in: contexts/index.d.ts:392

Contact's last name

##### Returns

`string`

***

### phoneNumber

#### Get Signature

> **get** **phoneNumber**(): `string`

Defined in: contexts/index.d.ts:388

Contact's phone number

##### Returns

`string`

***

### userId

#### Get Signature

> **get** **userId**(): `number`

Defined in: contexts/index.d.ts:394

Contact's user identifier in Telegram

##### Returns

`number`

***

### vCard

#### Get Signature

> **get** **vCard**(): `string`

Defined in: contexts/index.d.ts:396

Additional data about the contact in the form of a vCard

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/ContactAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ContactAttachment

# Class: ContactAttachment

Defined in: contexts/index.d.ts:400

This object represents a phone contact.

## Extends

* [`Contact`](Contact.md).[`Attachment`](Attachment.md)

## Constructors

### Constructor

> **new ContactAttachment**(`payload`): `ContactAttachment`

Defined in: contexts/index.d.ts:384

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramContact`](../../../../gramio/interfaces/TelegramContact.md) |

#### Returns

`ContactAttachment`

#### Inherited from

[`Contact`](Contact.md).[`constructor`](Contact.md#constructor)

## Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
|  `attachmentType` | [`AttachmentType`](../type-aliases/AttachmentType.md) | [`Attachment`](Attachment.md).[`attachmentType`](Attachment.md#attachmenttype) | contexts/index.d.ts:401 |
|  `payload` | [`TelegramContact`](../../../../gramio/interfaces/TelegramContact.md) | [`Contact`](Contact.md).[`payload`](Contact.md#payload) | contexts/index.d.ts:383 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:386

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Contact`](Contact.md).[`[toStringTag]`](Contact.md#tostringtag)

***

### firstName

#### Get Signature

> **get** **firstName**(): `string`

Defined in: contexts/index.d.ts:390

Contact's first name

##### Returns

`string`

#### Inherited from

[`Contact`](Contact.md).[`firstName`](Contact.md#firstname)

***

### lastName

#### Get Signature

> **get** **lastName**(): `string`

Defined in: contexts/index.d.ts:392

Contact's last name

##### Returns

`string`

#### Inherited from

[`Contact`](Contact.md).[`lastName`](Contact.md#lastname)

***

### phoneNumber

#### Get Signature

> **get** **phoneNumber**(): `string`

Defined in: contexts/index.d.ts:388

Contact's phone number

##### Returns

`string`

#### Inherited from

[`Contact`](Contact.md).[`phoneNumber`](Contact.md#phonenumber)

***

### userId

#### Get Signature

> **get** **userId**(): `number`

Defined in: contexts/index.d.ts:394

Contact's user identifier in Telegram

##### Returns

`number`

#### Inherited from

[`Contact`](Contact.md).[`userId`](Contact.md#userid)

***

### vCard

#### Get Signature

> **get** **vCard**(): `string`

Defined in: contexts/index.d.ts:396

Additional data about the contact in the form of a vCard

##### Returns

`string`

#### Inherited from

[`Contact`](Contact.md).[`vCard`](Contact.md#vcard)

---

---
url: 'https://gramio.dev/api/contexts/classes/Context.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Context

# Class: Context\<Bot>

Defined in: contexts/index.d.ts:4725

Main base context

## Extended by

* [`BoostAddedContext`](BoostAddedContext.md)
* [`BusinessConnectionContext`](BusinessConnectionContext.md)
* [`BusinessMessagesDeletedContext`](BusinessMessagesDeletedContext.md)
* [`CallbackQueryContext`](CallbackQueryContext.md)
* [`ChatActionMixin`](ChatActionMixin.md)
* [`ChatBackgroundSetContext`](ChatBackgroundSetContext.md)
* [`ChatBoostContext`](ChatBoostContext.md)
* [`ChatControlMixin`](ChatControlMixin.md)
* [`ChatInviteControlMixin`](ChatInviteControlMixin.md)
* [`ChatJoinRequestContext`](ChatJoinRequestContext.md)
* [`ChatMemberContext`](ChatMemberContext.md)
* [`ChatMemberControlMixin`](ChatMemberControlMixin.md)
* [`ChatOwnerChangedContext`](ChatOwnerChangedContext.md)
* [`ChatOwnerLeftContext`](ChatOwnerLeftContext.md)
* [`ChatSenderControlMixin`](ChatSenderControlMixin.md)
* [`ChatSharedContext`](ChatSharedContext.md)
* [`ChecklistTasksAddedContext`](ChecklistTasksAddedContext.md)
* [`ChecklistTasksDoneContext`](ChecklistTasksDoneContext.md)
* [`ChosenInlineResultContext`](ChosenInlineResultContext.md)
* [`CloneMixin`](CloneMixin.md)
* [`DeleteChatPhotoContext`](DeleteChatPhotoContext.md)
* [`DirectMessagePriceChangedContext`](DirectMessagePriceChangedContext.md)
* [`DownloadMixin`](DownloadMixin.md)
* [`ForumMixin`](ForumMixin.md)
* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiftContext`](GiftContext.md)
* [`GiftUpgradeSentContext`](GiftUpgradeSentContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)
* [`GroupChatCreatedContext`](GroupChatCreatedContext.md)
* [`InlineQueryContext`](InlineQueryContext.md)
* [`InvoiceContext`](InvoiceContext.md)
* [`LeftChatMemberContext`](LeftChatMemberContext.md)
* [`LocationContext`](LocationContext.md)
* [`MessageAutoDeleteTimerChangedContext`](MessageAutoDeleteTimerChangedContext.md)
* [`MessageContext`](MessageContext.md)
* [`MessageReactionContext`](MessageReactionContext.md)
* [`MessageReactionCountContext`](MessageReactionCountContext.md)
* [`MigrateFromChatIdContext`](MigrateFromChatIdContext.md)
* [`MigrateToChatIdContext`](MigrateToChatIdContext.md)
* [`NewChatMembersContext`](NewChatMembersContext.md)
* [`NewChatPhotoContext`](NewChatPhotoContext.md)
* [`NewChatTitleContext`](NewChatTitleContext.md)
* [`NodeMixin`](NodeMixin.md)
* [`PaidMediaPurchasedContext`](PaidMediaPurchasedContext.md)
* [`PaidMessagePriceChangedContext`](PaidMessagePriceChangedContext.md)
* [`PassportDataContext`](PassportDataContext.md)
* [`PinnedMessageContext`](PinnedMessageContext.md)
* [`PinsMixin`](PinsMixin.md)
* [`PollAnswerContext`](PollAnswerContext.md)
* [`PollContext`](PollContext.md)
* [`PreCheckoutQueryContext`](PreCheckoutQueryContext.md)
* [`ProximityAlertTriggeredContext`](ProximityAlertTriggeredContext.md)
* [`RefundedPaymentContext`](RefundedPaymentContext.md)
* [`RemovedChatBoostContext`](RemovedChatBoostContext.md)
* [`SendMixin`](SendMixin.md)
* [`ShippingQueryContext`](ShippingQueryContext.md)
* [`SuccessfulPaymentContext`](SuccessfulPaymentContext.md)
* [`SuggestedPostApprovalFailedContext`](SuggestedPostApprovalFailedContext.md)
* [`SuggestedPostApprovedContext`](SuggestedPostApprovedContext.md)
* [`SuggestedPostDeclinedContext`](SuggestedPostDeclinedContext.md)
* [`SuggestedPostPaidContext`](SuggestedPostPaidContext.md)
* [`SuggestedPostRefundedContext`](SuggestedPostRefundedContext.md)
* [`UniqueGiftContext`](UniqueGiftContext.md)
* [`UsersSharedContext`](UsersSharedContext.md)
* [`VideoChatEndedContext`](VideoChatEndedContext.md)
* [`VideoChatParticipantsInvitedContext`](VideoChatParticipantsInvitedContext.md)
* [`VideoChatScheduledContext`](VideoChatScheduledContext.md)
* [`VideoChatStartedContext`](VideoChatStartedContext.md)
* [`WebAppDataContext`](WebAppDataContext.md)
* [`WriteAccessAllowedContext`](WriteAccessAllowedContext.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new Context**<`Bot`>(`options`): `Context`<`Bot`>

Defined in: contexts/index.d.ts:4730

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ContextOptions`<`Bot`> |

#### Returns

`Context`<`Bot`>

## Properties

| Property | Modifier | Type | Defined in |
| ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | contexts/index.d.ts:4726 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

## Methods

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

---

---
url: 'https://gramio.dev/api/contexts/classes/DeleteChatPhotoContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / DeleteChatPhotoContext

# Class: DeleteChatPhotoContext\<Bot>

Defined in: contexts/index.d.ts:5634

Service message: the chat photo was deleted

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`DeleteChatPhotoContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `DeleteChatPhotoContext`<`Bot`>, `DeleteChatPhotoContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new DeleteChatPhotoContext**<`Bot`>(`options`): `DeleteChatPhotoContext`<`Bot`>

Defined in: contexts/index.d.ts:5637

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `DeleteChatPhotoContextOptions`<`Bot`> |

#### Returns

`DeleteChatPhotoContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new DeleteChatPhotoContext**(...`args`): `DeleteChatPhotoContext`

Defined in: contexts/index.d.ts:5634

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`DeleteChatPhotoContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5636 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `DeleteChatPhotoContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `DeleteChatPhotoContextOptions` |

#### Returns

`DeleteChatPhotoContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<DeleteChatPhotoContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<DeleteChatPhotoContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<DeleteChatPhotoContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<DeleteChatPhotoContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<DeleteChatPhotoContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<DeleteChatPhotoContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<DeleteChatPhotoContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<DeleteChatPhotoContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<DeleteChatPhotoContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<DeleteChatPhotoContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<DeleteChatPhotoContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<DeleteChatPhotoContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/Dice.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Dice

# Class: Dice

Defined in: contexts/index.d.ts:1460

This object represents an animated emoji that displays a random value.

## Constructors

### Constructor

> **new Dice**(`payload`): `Dice`

Defined in: contexts/index.d.ts:1462

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramDice`](../../../../gramio/interfaces/TelegramDice.md) |

#### Returns

`Dice`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramDice`](../../../../gramio/interfaces/TelegramDice.md) | contexts/index.d.ts:1461 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1464

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### emoji

#### Get Signature

> **get** **emoji**(): `NonNullable`<[`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md)>

Defined in: contexts/index.d.ts:1466

Emoji on which the dice throw animation is based

##### Returns

`NonNullable`<[`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md)>

***

### value

#### Get Signature

> **get** **value**(): `number`

Defined in: contexts/index.d.ts:1473

Value of the dice,
`1-6` for `🎲`, `🎯` and `🎳` base emoji,
`1-5` for `🏀` and `⚽️` base emoji,
`1-64` for `🎰` base emoji

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/DirectMessagePriceChanged.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / DirectMessagePriceChanged

# Class: DirectMessagePriceChanged

Defined in: contexts/index.d.ts:2501

Describes a service message about a change in the price of direct messages sent to a channel chat.

[Documentation](https://core.telegram.org/bots/api/#directmessagepricechanged)

## Constructors

### Constructor

> **new DirectMessagePriceChanged**(`payload`): `DirectMessagePriceChanged`

Defined in: contexts/index.d.ts:2503

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramDirectMessagePriceChanged`](../../../../gramio/interfaces/TelegramDirectMessagePriceChanged.md) |

#### Returns

`DirectMessagePriceChanged`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramDirectMessagePriceChanged`](../../../../gramio/interfaces/TelegramDirectMessagePriceChanged.md) | contexts/index.d.ts:2502 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2504

##### Returns

`string`

***

### areDirectMessagesEnabled

#### Get Signature

> **get** **areDirectMessagesEnabled**(): `boolean`

Defined in: contexts/index.d.ts:2508

*True*, if direct messages are enabled for the channel chat; false otherwise

##### Returns

`boolean`

***

### directMessageStarCount

#### Get Signature

> **get** **directMessageStarCount**(): `number`

Defined in: contexts/index.d.ts:2512

*Optional*. The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0.

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/DirectMessagePriceChangedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / DirectMessagePriceChangedContext

# Class: DirectMessagePriceChangedContext\<Bot>

Defined in: contexts/index.d.ts:5649

This object represents a service message about direct message price changed.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`DirectMessagePriceChangedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `DirectMessagePriceChangedContext`<`Bot`>, `DirectMessagePriceChangedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new DirectMessagePriceChangedContext**<`Bot`>(`options`): `DirectMessagePriceChangedContext`<`Bot`>

Defined in: contexts/index.d.ts:5653

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `DirectMessagePriceChangedContextOptions`<`Bot`> |

#### Returns

`DirectMessagePriceChangedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new DirectMessagePriceChangedContext**(...`args`): `DirectMessagePriceChangedContext`

Defined in: contexts/index.d.ts:5649

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`DirectMessagePriceChangedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `event` | `public` | [`TelegramDirectMessagePriceChanged`](../../../../gramio/interfaces/TelegramDirectMessagePriceChanged.md) | - | - | contexts/index.d.ts:5652 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5651 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### areDirectMessagesEnabled

#### Get Signature

> **get** **areDirectMessagesEnabled**(): `boolean`

Defined in: contexts/index.d.ts:5657

*True*, if direct messages are enabled for the channel chat; false otherwise

##### Returns

`boolean`

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessageStarCount

#### Get Signature

> **get** **directMessageStarCount**(): `number`

Defined in: contexts/index.d.ts:5661

*Optional*. The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0.

##### Returns

`number`

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `DirectMessagePriceChangedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `DirectMessagePriceChangedContextOptions` |

#### Returns

`DirectMessagePriceChangedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<DirectMessagePriceChangedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<DirectMessagePriceChangedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<DirectMessagePriceChangedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<DirectMessagePriceChangedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<DirectMessagePriceChangedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<DirectMessagePriceChangedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<DirectMessagePriceChangedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<DirectMessagePriceChangedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<DirectMessagePriceChangedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<DirectMessagePriceChangedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<DirectMessagePriceChangedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<DirectMessagePriceChangedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/DirectMessagesTopic.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / DirectMessagesTopic

# Class: DirectMessagesTopic

Defined in: contexts/index.d.ts:2520

Describes a topic of a direct messages chat.

[Documentation](https://core.telegram.org/bots/api/#directmessagestopic)

## Constructors

### Constructor

> **new DirectMessagesTopic**(`payload`): `DirectMessagesTopic`

Defined in: contexts/index.d.ts:2522

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramDirectMessagesTopic`](../../../../gramio/interfaces/TelegramDirectMessagesTopic.md) |

#### Returns

`DirectMessagesTopic`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramDirectMessagesTopic`](../../../../gramio/interfaces/TelegramDirectMessagesTopic.md) | contexts/index.d.ts:2521 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2524

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### topicId

#### Get Signature

> **get** **topicId**(): `number`

Defined in: contexts/index.d.ts:2528

Unique identifier of the topic

##### Returns

`number`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2532

*Optional*. Information about the user that created the topic. Currently, it is always present

##### Returns

[`User`](User.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/DocumentAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / DocumentAttachment

# Class: DocumentAttachment

Defined in: contexts/index.d.ts:410

This object represents a general file (as opposed to photos, voice messages
and audio files).

## Extends

* [`FileAttachment`](FileAttachment.md)<[`TelegramDocument`](../../../../gramio/interfaces/TelegramDocument.md)>

## Constructors

### Constructor

> **new DocumentAttachment**(`payload`): `DocumentAttachment`

Defined in: contexts/index.d.ts:327

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramDocument`](../../../../gramio/interfaces/TelegramDocument.md) |

#### Returns

`DocumentAttachment`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`constructor`](FileAttachment.md#constructor)

## Properties

| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|  `attachmentType` | `public` | [`AttachmentType`](../type-aliases/AttachmentType.md) | Returns attachment's type (e.g. `'audio'`, `'photo'`) | [`FileAttachment`](FileAttachment.md).[`attachmentType`](FileAttachment.md#attachmenttype) | - | contexts/index.d.ts:411 |
|  `payload` | `protected` | [`TelegramDocument`](../../../../gramio/interfaces/TelegramDocument.md) | - | - | [`FileAttachment`](FileAttachment.md).[`payload`](FileAttachment.md#payload) | contexts/index.d.ts:324 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:314

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`[toStringTag]`](FileAttachment.md#tostringtag)

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

Defined in: contexts/index.d.ts:329

Identifier for this file, which can be used to download or reuse the file

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileId`](FileAttachment.md#fileid)

***

### fileName

#### Get Signature

> **get** **fileName**(): `string`

Defined in: contexts/index.d.ts:415

Original filename as defined by sender

##### Returns

`string`

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

Defined in: contexts/index.d.ts:419

File size

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

Defined in: contexts/index.d.ts:334

Unique identifier for this file, which is supposed to be the same over
time and for different bots. Can't be used to download or reuse the file.

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileUniqueId`](FileAttachment.md#fileuniqueid)

***

### mimeType

#### Get Signature

> **get** **mimeType**(): `string`

Defined in: contexts/index.d.ts:417

MIME type of the file as defined by sender

##### Returns

`string`

***

### thumbnail

#### Get Signature

> **get** **thumbnail**(): [`PhotoSize`](PhotoSize.md)

Defined in: contexts/index.d.ts:413

Document thumbnail as defined by sender

##### Returns

[`PhotoSize`](PhotoSize.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/DownloadMixin.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / DownloadMixin

# Class: DownloadMixin\<Bot>

Defined in: contexts/index.d.ts:5282

This object represents a mixin that can be used to download media files

## Extends

* [`Context`](Context.md)<`Bot`>.`DownloadMixinMetadata`

## Extended by

* [`MessageContext`](MessageContext.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new DownloadMixin**<`Bot`>(): `DownloadMixin`<`Bot`>

#### Returns

`DownloadMixin`<`Bot`>

#### Inherited from

[`Context`](Context.md).[`constructor`](Context.md#constructor)

## Properties

| Property | Modifier | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### attachment

#### Get Signature

> **get** **attachment**(): [`Attachment`](Attachment.md)

Defined in: contexts/index.d.ts:5279

##### Returns

[`Attachment`](Attachment.md)

## Methods

### download()

#### Call Signature

> **download**(): `Promise`<`ArrayBuffer`>

Defined in: contexts/index.d.ts:5284

Downloads attachment

##### Returns

`Promise`<`ArrayBuffer`>

#### Call Signature

> **download**(`path`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5285

Downloads attachment

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `path` | `string` |

##### Returns

`Promise`<`string`>

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

---

---
url: 'https://gramio.dev/api/contexts/classes/EncryptedCredentials.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / EncryptedCredentials

# Class: EncryptedCredentials

Defined in: contexts/index.d.ts:2067

Contains data required for decrypting and authenticatin
`EncryptedPassportElement`. See the Telegram Passport Documentation for a
complete description of the data decryption and authentication processes.

## Constructors

### Constructor

> **new EncryptedCredentials**(`payload`): `EncryptedCredentials`

Defined in: contexts/index.d.ts:2069

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramEncryptedCredentials`](../../../../gramio/interfaces/TelegramEncryptedCredentials.md) |

#### Returns

`EncryptedCredentials`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramEncryptedCredentials`](../../../../gramio/interfaces/TelegramEncryptedCredentials.md) | contexts/index.d.ts:2068 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2071

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### data

#### Get Signature

> **get** **data**(): `string`

Defined in: contexts/index.d.ts:2077

Base64-encoded encrypted JSON-serialized data with unique user's payload,
data hashes and secrets required for `EncryptedPassportElement` decryption
and authentication

##### Returns

`string`

***

### hash

#### Get Signature

> **get** **hash**(): `string`

Defined in: contexts/index.d.ts:2079

Base64-encoded data hash for data authentication

##### Returns

`string`

***

### secret

#### Get Signature

> **get** **secret**(): `string`

Defined in: contexts/index.d.ts:2084

Base64-encoded secret, encrypted with the bot's public RSA key, required
for data decryption

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/EncryptedPassportElement.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / EncryptedPassportElement

# Class: EncryptedPassportElement

Defined in: contexts/index.d.ts:2116

Contains information about documents or other Telegram Passport elements
shared with the bot by the user.

## Constructors

### Constructor

> **new EncryptedPassportElement**(`payload`): `EncryptedPassportElement`

Defined in: contexts/index.d.ts:2118

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramEncryptedPassportElement`](../../../../gramio/interfaces/TelegramEncryptedPassportElement.md) |

#### Returns

`EncryptedPassportElement`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramEncryptedPassportElement`](../../../../gramio/interfaces/TelegramEncryptedPassportElement.md) | contexts/index.d.ts:2117 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2120

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### data

#### Get Signature

> **get** **data**(): `string`

Defined in: contexts/index.d.ts:2135

Base64-encoded encrypted Telegram Passport element data provided by th
user, available for `personal_details`, `passport`, `driver_license`,
`identity_card`, `internal_passport` and `address` types.
Can be decrypted and verified using the accompanying
`EncryptedCredentials`.

##### Returns

`string`

***

### email

#### Get Signature

> **get** **email**(): `string`

Defined in: contexts/index.d.ts:2139

User's verified email address, available only for `email` type

##### Returns

`string`

***

### files

#### Get Signature

> **get** **files**(): [`PassportFile`](PassportFile.md)\[]

Defined in: contexts/index.d.ts:2146

Array of encrypted files with documents provided by the user, available
for `utility_bill`, `bank_statement`, `rental_agreement`,
`passport_registration` and `temporary_registration` types. Files can be
decrypted and verified using the accompanying `EncryptedCredentials`.

##### Returns

[`PassportFile`](PassportFile.md)\[]

***

### frontSide

#### Get Signature

> **get** **frontSide**(): [`PassportFile`](PassportFile.md)

Defined in: contexts/index.d.ts:2153

Encrypted file with the front side of the document, provided by the user.
Available for `passport`, `driver_license`, `identity_card` and
`internal_passport`. The file can be decrypted and verified using the
accompanying `EncryptedCredentials`.

##### Returns

[`PassportFile`](PassportFile.md)

***

### hash

#### Get Signature

> **get** **hash**(): `string`

Defined in: contexts/index.d.ts:2179

Base64-encoded element hash for using in `PassportElementErrorUnspecified`

##### Returns

`string`

***

### phoneNumber

#### Get Signature

> **get** **phoneNumber**(): `string`

Defined in: contexts/index.d.ts:2137

User's verified phone number, available only for `phone_number` type

##### Returns

`string`

***

### reverseSide

#### Get Signature

> **get** **reverseSide**(): [`PassportFile`](PassportFile.md)

Defined in: contexts/index.d.ts:2159

Encrypted file with the reverse side of the document, provided by the
user. Available for `driver_license` and `identity_card`. The file can be
decrypted and verified using the accompanying `EncryptedCredentials`.

##### Returns

[`PassportFile`](PassportFile.md)

***

### selfie

#### Get Signature

> **get** **selfie**(): [`PassportFile`](PassportFile.md)

Defined in: contexts/index.d.ts:2166

Encrypted file with the selfie of the user holding a document, provided by
the user; available for `passport`, `driver_license`, `identity_card` and
`internal_passport`. The file can be decrypted and verified using the
accompanying `EncryptedCredentials`.

##### Returns

[`PassportFile`](PassportFile.md)

***

### translation

#### Get Signature

> **get** **translation**(): [`PassportFile`](PassportFile.md)\[]

Defined in: contexts/index.d.ts:2175

Array of encrypted files with translated versions of documents provided by
the user. Available if requested for `passport`, `driver_license`,
`identity_card`, `internal_passport`, `utility_bill`, `bank_statement`,
`rental_agreement`, `passport_registration` and `temporary_registration`
types. Files can be decrypted and verified using the accompanying
`EncryptedCredentials`.

##### Returns

[`PassportFile`](PassportFile.md)\[]

***

### type

#### Get Signature

> **get** **type**(): [`TelegramEncryptedPassportElementType`](../../../../gramio/type-aliases/TelegramEncryptedPassportElementType.md)

Defined in: contexts/index.d.ts:2127

Element type. One of `personal_details`, `passport`, `driver_license`,
`identity_card`, `internal_passport`, `address`, `utility_bill`,
`bank_statement`, `rental_agreement`, `passport_registration`,
`temporary_registration`, `phone_number`, `email`.

##### Returns

[`TelegramEncryptedPassportElementType`](../../../../gramio/type-aliases/TelegramEncryptedPassportElementType.md)

---

---
url: 'https://gramio.dev/api/composer/classes/EventQueue.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / EventQueue

# Class: EventQueue\<T>

Defined in: composer/index.d.ts:203

Concurrent event queue with graceful shutdown support.
Processes events in parallel (like an event loop), not sequentially.

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Constructors

### Constructor

> **new EventQueue**<`T`>(`handler`): `EventQueue`<`T`>

Defined in: composer/index.d.ts:209

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | (`event`) => `Promise`<`unknown`> |

#### Returns

`EventQueue`<`T`>

## Accessors

### isActive

#### Get Signature

> **get** **isActive**(): `boolean`

Defined in: composer/index.d.ts:216

##### Returns

`boolean`

***

### pending

#### Get Signature

> **get** **pending**(): `number`

Defined in: composer/index.d.ts:214

##### Returns

`number`

***

### queued

#### Get Signature

> **get** **queued**(): `number`

Defined in: composer/index.d.ts:215

##### Returns

`number`

## Methods

### add()

> **add**(`event`): `void`

Defined in: composer/index.d.ts:210

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | `T` |

#### Returns

`void`

***

### addBatch()

> **addBatch**(`events`): `void`

Defined in: composer/index.d.ts:211

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `events` | `T`\[] |

#### Returns

`void`

***

### onIdle()

> **onIdle**(): `Promise`<`void`>

Defined in: composer/index.d.ts:213

#### Returns

`Promise`<`void`>

***

### stop()

> **stop**(`timeout?`): `Promise`<`void`>

Defined in: composer/index.d.ts:212

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `timeout?` | `number` |

#### Returns

`Promise`<`void`>

---

---
url: 'https://gramio.dev/api/contexts/classes/ExternalReplyInfo.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ExternalReplyInfo

# Class: ExternalReplyInfo

Defined in: contexts/index.d.ts:1831

This object contains information about a message that is being replied to, which may come from another chat or forum topic.

## Constructors

### Constructor

> **new ExternalReplyInfo**(`payload`): `ExternalReplyInfo`

Defined in: contexts/index.d.ts:1833

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramExternalReplyInfo`](../../../../gramio/interfaces/TelegramExternalReplyInfo.md) |

#### Returns

`ExternalReplyInfo`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramExternalReplyInfo`](../../../../gramio/interfaces/TelegramExternalReplyInfo.md) | contexts/index.d.ts:1832 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1835

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:1846

Message is an animation, information about the animation

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:1848

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:1839

Chat the original message belongs to. Available only if the chat is a supergroup or a channel.

##### Returns

[`Chat`](Chat.md)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:1844

##### Returns

[`Checklist`](Checklist.md)

***

### contact

#### Get Signature

> **get** **contact**(): [`ContactAttachment`](ContactAttachment.md)

Defined in: contexts/index.d.ts:1866

Message is a shared contact, information about the contact

##### Returns

[`ContactAttachment`](ContactAttachment.md)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:1868

Message is a dice with random value

##### Returns

[`Dice`](Dice.md)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:1850

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:1870

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:1872

Message is a scheduled giveaway, information about the giveaway

##### Returns

[`Giveaway`](Giveaway.md)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:1874

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:1876

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:1843

Options used for link preview generation for the original message, if it is a text message

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:1878

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

***

### messageId

#### Get Signature

> **get** **messageId**(): `number`

Defined in: contexts/index.d.ts:1841

Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel.

##### Returns

`number`

***

### origin

#### Get Signature

> **get** **origin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:1837

Origin of the message replied to by the given message

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

***

### paidMedia

#### Get Signature

> **get** **paidMedia**(): [`PaidMediaInfo`](PaidMediaInfo.md)

Defined in: contexts/index.d.ts:1883

##### Returns

[`PaidMediaInfo`](PaidMediaInfo.md)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoAttachment`](PhotoAttachment.md)

Defined in: contexts/index.d.ts:1852

Message is a photo, available sizes of the photo

##### Returns

[`PhotoAttachment`](PhotoAttachment.md)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:1880

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:1854

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:1856

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:1882

Message is a venue, information about the venue

##### Returns

[`Venue`](Venue.md)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:1858

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:1860

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:1862

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

## Methods

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:1864

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

---

---
url: 'https://gramio.dev/api/contexts/classes/File.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / File

# Class: File

Defined in: contexts/index.d.ts:660

This object represents a file ready to be downloaded. The file can be downloaded via the link `https://api.telegram.org/file/bot<token>/<file_path>`. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling `getFile`.

## Constructors

### Constructor

> **new File**(`payload`): `File`

Defined in: contexts/index.d.ts:662

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramFile`](../../../../gramio/interfaces/TelegramFile.md) |

#### Returns

`File`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramFile`](../../../../gramio/interfaces/TelegramFile.md) | contexts/index.d.ts:661 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:664

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

Defined in: contexts/index.d.ts:668

Identifier for this file, which can be used to download or reuse the file

##### Returns

`string`

***

### filePath

#### Get Signature

> **get** **filePath**(): `string`

Defined in: contexts/index.d.ts:681

File path.
Use `https://api.telegram.org/file/bot<token>/<file_path>` to get the
file.

##### Returns

`string`

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

Defined in: contexts/index.d.ts:675

File size, if known

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

Defined in: contexts/index.d.ts:673

Unique identifier for this file, which is supposed to be the same over
time and for different bots. Can't be used to download or reuse the file.

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/FileAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / FileAttachment

# Class: FileAttachment\<T>

Defined in: contexts/index.d.ts:323

Attachment with `fileId` and `fileUniqueId` properties

## Extends

* [`Attachment`](Attachment.md)

## Extended by

* [`AnimationAttachment`](AnimationAttachment.md)
* [`AudioAttachment`](AudioAttachment.md)
* [`DocumentAttachment`](DocumentAttachment.md)
* [`StickerAttachment`](StickerAttachment.md)
* [`VideoAttachment`](VideoAttachment.md)
* [`VideoNoteAttachment`](VideoNoteAttachment.md)
* [`VoiceAttachment`](VoiceAttachment.md)

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` *extends* [`DefaultAttachment`](../interfaces/DefaultAttachment.md) | [`DefaultAttachment`](../interfaces/DefaultAttachment.md) |

## Constructors

### Constructor

> **new FileAttachment**<`T`>(`payload`): `FileAttachment`<`T`>

Defined in: contexts/index.d.ts:327

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `T` |

#### Returns

`FileAttachment`<`T`>

#### Overrides

[`Attachment`](Attachment.md).[`constructor`](Attachment.md#constructor)

## Properties

| Property | Modifier | Type | Description | Overrides | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `attachmentType?` | `public` | [`AttachmentType`](../type-aliases/AttachmentType.md) | Returns attachment's type (e.g. `'audio'`, `'photo'`) | [`Attachment`](Attachment.md).[`attachmentType`](Attachment.md#attachmenttype) | contexts/index.d.ts:326 |
|  `payload` | `protected` | `T` | - | - | contexts/index.d.ts:324 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:314

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Attachment`](Attachment.md).[`[toStringTag]`](Attachment.md#tostringtag)

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

Defined in: contexts/index.d.ts:329

Identifier for this file, which can be used to download or reuse the file

##### Returns

`string`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

Defined in: contexts/index.d.ts:334

Unique identifier for this file, which is supposed to be the same over
time and for different bots. Can't be used to download or reuse the file.

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/keyboards/classes/ForceReplyKeyboard.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / ForceReplyKeyboard

# Class: ForceReplyKeyboard

Defined in: keyboards/index.d.ts:619

**ForceReply** builder

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](https://core.telegram.org/bots/features#privacy-mode).

[\[Documentation\]](https://core.telegram.org/bots/api/#forcereply)

## Constructors

### Constructor

> **new ForceReplyKeyboard**(): `ForceReplyKeyboard`

#### Returns

`ForceReplyKeyboard`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `options` | `object` | keyboards/index.d.ts:620 |
| `options.isSelective` | `boolean` | keyboards/index.d.ts:621 |
| `options.placeholder` | `string` | keyboards/index.d.ts:622 |

## Methods

### build()

> **build**(): [`TelegramForceReply`](../../../../gramio/interfaces/TelegramForceReply.md)

Defined in: keyboards/index.d.ts:645

Return [TelegramForceReply](../../../../gramio/interfaces/TelegramForceReply.md) as JSON

#### Returns

[`TelegramForceReply`](../../../../gramio/interfaces/TelegramForceReply.md)

***

### placeholder()

> **placeholder**(`value?`): `this`

Defined in: keyboards/index.d.ts:641

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `value?` | `string` |

#### Returns

`this`

#### Example

```ts
new Keyboard().placeholder("some text"); // to enable
new Keyboard().placeholder(); // to disable
```

***

### selective()

> **selective**(`isEnabled?`): `this`

Defined in: keyboards/index.d.ts:632

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](https://core.telegram.org/bots/api/#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.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `isEnabled?` | `boolean` |

#### Returns

`this`

#### Example

```ts
new ForceReplyKeyboard().selective(); // to enable
new ForceReplyKeyboard().selective(false); // to disable
```

***

### toJSON()

> **toJSON**(): [`TelegramForceReply`](../../../../gramio/interfaces/TelegramForceReply.md)

Defined in: keyboards/index.d.ts:649

Serializing a class into an [TelegramForceReply](../../../../gramio/interfaces/TelegramForceReply.md) object (used by JSON.stringify)

#### Returns

[`TelegramForceReply`](../../../../gramio/interfaces/TelegramForceReply.md)

---

---
url: 'https://gramio.dev/api/gramio/classes/FormattableString.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / FormattableString

# Class: FormattableString

Defined in: format/formattable-string-BKevNsLk.d.ts:8

Class-helper for work with formattable [entities](https://core.telegram.org/bots/api#messageentity)

## Constructors

### Constructor

> **new FormattableString**(`text`, `entities`): `FormattableString`

Defined in: format/formattable-string-BKevNsLk.d.ts:14

Create new FormattableString

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `entities` | [`TelegramMessageEntity`](../interfaces/TelegramMessageEntity.md)\[] |

#### Returns

`FormattableString`

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `entities` | [`TelegramMessageEntity`](../interfaces/TelegramMessageEntity.md)\[] | Entities of FormattableString | format/formattable-string-BKevNsLk.d.ts:12 |
|  `text` | `string` | Text of FormattableString (auto covert to it if entities is unsupported) | format/formattable-string-BKevNsLk.d.ts:10 |

## Methods

### toJSON()

> **toJSON**(): `string`

Defined in: format/formattable-string-BKevNsLk.d.ts:18

#### Returns

`string`

***

### toString()

> **toString**(): `string`

Defined in: format/formattable-string-BKevNsLk.d.ts:17

#### Returns

`string`

***

### \[hasInstance]\()

> `static` **\[hasInstance]**(`value`): `value is FormattableString`

Defined in: format/formattable-string-BKevNsLk.d.ts:19

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `unknown` |

#### Returns

`value is FormattableString`

***

### from()

> `static` **from**(`text`, `entities`): `FormattableString`

Defined in: format/formattable-string-BKevNsLk.d.ts:16

Create new FormattableString

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `entities` | [`TelegramMessageEntity`](../interfaces/TelegramMessageEntity.md)\[] |

#### Returns

`FormattableString`

---

---
url: 'https://gramio.dev/api/contexts/classes/ForumMixin.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ForumMixin

# Class: ForumMixin\<Bot>

Defined in: contexts/index.d.ts:5159

This object represents a mixin that's used in all topic-related updates

## Extends

* [`Context`](Context.md)<`Bot`>.`ForumMixinMetadata`.[`NodeMixin`](NodeMixin.md)<`Bot`>

## Extended by

* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ForumMixin**<`Bot`>(): `ForumMixin`<`Bot`>

#### Returns

`ForumMixin`<`Bot`>

#### Inherited from

[`Context`](Context.md).[`constructor`](Context.md#constructor)

## Properties

| Property | Modifier | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | [`NodeMixin`](NodeMixin.md).[`isTopicMessage`](NodeMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`businessConnectionId`](NodeMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4859

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`chatId`](NodeMixin.md#chatid)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4944

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`id`](NodeMixin.md#id)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4861

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`senderId`](NodeMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:5156

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`threadId`](NodeMixin.md#threadid)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### closeGeneralTopic()

> **closeGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5173

Closes General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseGeneralForumTopicParams`](../../../../gramio/interfaces/CloseGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### closeTopic()

> **closeTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5171

Closes topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseForumTopicParams`](../../../../gramio/interfaces/CloseForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### createTopic()

> **createTopic**(`name`, `params?`): `Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

Defined in: contexts/index.d.ts:5165

Creates a topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateForumTopicParams`](../../../../gramio/interfaces/CreateForumTopicParams.md), `"name"` | `"chat_id"`> |

#### Returns

`Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### deleteTopic()

> **deleteTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5179

Deletes topic along with all its messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteForumTopicParams`](../../../../gramio/interfaces/DeleteForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editGeneralTopic()

> **editGeneralTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5169

Edits General topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditGeneralForumTopicParams`](../../../../gramio/interfaces/EditGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### editTopic()

> **editTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5167

Edits topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditForumTopicParams`](../../../../gramio/interfaces/EditForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`getChatBoosts`](NodeMixin.md#getchatboosts)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

Defined in: contexts/index.d.ts:5163

Returns custom emoji stickers, which can be used as a forum topic icon by any user

#### Returns

`Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

***

### hideGeneralTopic()

> **hideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5185

Hides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`HideGeneralForumTopicParams`](../../../../gramio/interfaces/HideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isGeneralTopic()

> **isGeneralTopic**(): `this is RequireValue<ForumMixin<Bot>, "threadId", undefined>`

Defined in: contexts/index.d.ts:5161

Checks whether this topic is actually a 'General' one

#### Returns

`this is RequireValue<ForumMixin<Bot>, "threadId", undefined>`

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reopenGeneralTopic()

> **reopenGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5177

Reopens General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenGeneralForumTopicParams`](../../../../gramio/interfaces/ReopenGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### reopenTopic()

> **reopenTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5175

Reopens topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenForumTopicParams`](../../../../gramio/interfaces/ReopenForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`send`](NodeMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendAnimation`](NodeMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendAudio`](NodeMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendChatAction`](NodeMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendChecklist`](NodeMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendContact`](NodeMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendDice`](NodeMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendDocument`](NodeMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendInvoice`](NodeMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendLocation`](NodeMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendMedia`](NodeMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendMediaGroup`](NodeMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendMessageDraft`](NodeMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendPaidMedia`](NodeMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendPhoto`](NodeMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendPoll`](NodeMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendSticker`](NodeMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVenue`](NodeMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVideo`](NodeMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVideoNote`](NodeMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVoice`](NodeMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopPoll`](NodeMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`streamMessage`](NodeMixin.md#streammessage)

***

### unhideGeneralTopic()

> **unhideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5187

Unhides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnhideGeneralForumTopicParams`](../../../../gramio/interfaces/UnhideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### unpinAllGeneralTopicMessages()

> **unpinAllGeneralTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5183

Clears the list of pinned messages in a General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllGeneralForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllGeneralForumTopicMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### unpinAllTopicMessages()

> **unpinAllTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5181

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllForumTopicMessagesParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

---

---
url: 'https://gramio.dev/api/contexts/classes/ForumTopicClosed.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ForumTopicClosed

# Class: ForumTopicClosed

Defined in: contexts/index.d.ts:1887

This object represents a service message about a forum topic closed in the chat. Currently holds no information.

## Constructors

### Constructor

> **new ForumTopicClosed**(`payload`): `ForumTopicClosed`

Defined in: contexts/index.d.ts:1889

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramForumTopicClosed`](../../../../gramio/interfaces/TelegramForumTopicClosed.md) |

#### Returns

`ForumTopicClosed`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramForumTopicClosed`](../../../../gramio/interfaces/TelegramForumTopicClosed.md) | contexts/index.d.ts:1888 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1891

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/ForumTopicClosedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ForumTopicClosedContext

# Class: ForumTopicClosedContext\<Bot>

Defined in: contexts/index.d.ts:5673

This object represents a service message about a forum topic closed in the chat. Currently holds no information.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ForumTopicClosedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ForumMixin`](ForumMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ForumTopicClosedContext`<`Bot`>, `ForumTopicClosedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ForumTopicClosedContext**<`Bot`>(`options`): `ForumTopicClosedContext`<`Bot`>

Defined in: contexts/index.d.ts:5676

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ForumTopicClosedContextOptions`<`Bot`> |

#### Returns

`ForumTopicClosedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ForumTopicClosedContext**(...`args`): `ForumTopicClosedContext`

Defined in: contexts/index.d.ts:5673

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ForumTopicClosedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5675 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `ForumTopicClosedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ForumTopicClosedContextOptions` |

#### Returns

`ForumTopicClosedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### closeGeneralTopic()

> **closeGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5173

Closes General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseGeneralForumTopicParams`](../../../../gramio/interfaces/CloseGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeGeneralTopic`](ForumMixin.md#closegeneraltopic)

***

### closeTopic()

> **closeTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5171

Closes topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseForumTopicParams`](../../../../gramio/interfaces/CloseForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeTopic`](ForumMixin.md#closetopic)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### createTopic()

> **createTopic**(`name`, `params?`): `Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

Defined in: contexts/index.d.ts:5165

Creates a topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateForumTopicParams`](../../../../gramio/interfaces/CreateForumTopicParams.md), `"name"` | `"chat_id"`> |

#### Returns

`Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`createTopic`](ForumMixin.md#createtopic)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### deleteTopic()

> **deleteTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5179

Deletes topic along with all its messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteForumTopicParams`](../../../../gramio/interfaces/DeleteForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`deleteTopic`](ForumMixin.md#deletetopic)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editGeneralTopic()

> **editGeneralTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5169

Edits General topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditGeneralForumTopicParams`](../../../../gramio/interfaces/EditGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editGeneralTopic`](ForumMixin.md#editgeneraltopic)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### editTopic()

> **editTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5167

Edits topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditForumTopicParams`](../../../../gramio/interfaces/EditForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editTopic`](ForumMixin.md#edittopic)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

Defined in: contexts/index.d.ts:5163

Returns custom emoji stickers, which can be used as a forum topic icon by any user

#### Returns

`Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`getTopicIcons`](ForumMixin.md#gettopicicons)

***

### hasFrom()

> **hasFrom**(): this is Require\<ForumTopicClosedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ForumTopicClosedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ForumTopicClosedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ForumTopicClosedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### hideGeneralTopic()

> **hideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5185

Hides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`HideGeneralForumTopicParams`](../../../../gramio/interfaces/HideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`hideGeneralTopic`](ForumMixin.md#hidegeneraltopic)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ForumTopicClosedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ForumTopicClosedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGeneralTopic()

> **isGeneralTopic**(): `this is RequireValue<ForumTopicClosedContext<Bot>, "threadId", undefined>`

Defined in: contexts/index.d.ts:5161

Checks whether this topic is actually a 'General' one

#### Returns

`this is RequireValue<ForumTopicClosedContext<Bot>, "threadId", undefined>`

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`isGeneralTopic`](ForumMixin.md#isgeneraltopic)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ForumTopicClosedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ForumTopicClosedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<ForumTopicClosedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ForumTopicClosedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ForumTopicClosedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ForumTopicClosedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reopenGeneralTopic()

> **reopenGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5177

Reopens General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenGeneralForumTopicParams`](../../../../gramio/interfaces/ReopenGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenGeneralTopic`](ForumMixin.md#reopengeneraltopic)

***

### reopenTopic()

> **reopenTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5175

Reopens topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenForumTopicParams`](../../../../gramio/interfaces/ReopenForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenTopic`](ForumMixin.md#reopentopic)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unhideGeneralTopic()

> **unhideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5187

Unhides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnhideGeneralForumTopicParams`](../../../../gramio/interfaces/UnhideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unhideGeneralTopic`](ForumMixin.md#unhidegeneraltopic)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinAllGeneralTopicMessages()

> **unpinAllGeneralTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5183

Clears the list of pinned messages in a General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllGeneralForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllGeneralForumTopicMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllGeneralTopicMessages`](ForumMixin.md#unpinallgeneraltopicmessages)

***

### unpinAllTopicMessages()

> **unpinAllTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5181

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllForumTopicMessagesParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllTopicMessages`](ForumMixin.md#unpinalltopicmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ForumTopicCreated.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ForumTopicCreated

# Class: ForumTopicCreated

Defined in: contexts/index.d.ts:1895

This object represents a service message about a new forum topic created in the chat.

## Constructors

### Constructor

> **new ForumTopicCreated**(`payload`): `ForumTopicCreated`

Defined in: contexts/index.d.ts:1897

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramForumTopicCreated`](../../../../gramio/interfaces/TelegramForumTopicCreated.md) |

#### Returns

`ForumTopicCreated`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramForumTopicCreated`](../../../../gramio/interfaces/TelegramForumTopicCreated.md) | contexts/index.d.ts:1896 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1899

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### iconColor

#### Get Signature

> **get** **iconColor**(): `number`

Defined in: contexts/index.d.ts:1903

Color of the topic icon in RGB format

##### Returns

`number`

***

### iconCustomEmojiId

#### Get Signature

> **get** **iconCustomEmojiId**(): `string`

Defined in: contexts/index.d.ts:1905

Unique identifier of the custom emoji shown as the topic icon

##### Returns

`string`

***

### isNameImplicit

#### Get Signature

> **get** **isNameImplicit**(): `true`

Defined in: contexts/index.d.ts:1907

*Optional*. True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot

##### Returns

`true`

***

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: contexts/index.d.ts:1901

Name of the topic

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/ForumTopicCreatedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ForumTopicCreatedContext

# Class: ForumTopicCreatedContext\<Bot>

Defined in: contexts/index.d.ts:5688

This object represents a service message about a new forum topic created in the chat.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ForumTopicCreatedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ForumMixin`](ForumMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ForumTopicCreatedContext`<`Bot`>, `ForumTopicCreatedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ForumTopicCreatedContext**<`Bot`>(`options`): `ForumTopicCreatedContext`<`Bot`>

Defined in: contexts/index.d.ts:5692

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ForumTopicCreatedContextOptions`<`Bot`> |

#### Returns

`ForumTopicCreatedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ForumTopicCreatedContext**(...`args`): `ForumTopicCreatedContext`

Defined in: contexts/index.d.ts:5688

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ForumTopicCreatedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5690 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### iconColor

#### Get Signature

> **get** **iconColor**(): `number`

Defined in: contexts/index.d.ts:5696

Color of the topic icon in RGB format

##### Returns

`number`

***

### iconCustomEmojiId

#### Get Signature

> **get** **iconCustomEmojiId**(): `string`

Defined in: contexts/index.d.ts:5698

Unique identifier of the custom emoji shown as the topic icon

##### Returns

`string`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: contexts/index.d.ts:5694

Name of the topic

##### Returns

`string`

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `ForumTopicCreatedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ForumTopicCreatedContextOptions` |

#### Returns

`ForumTopicCreatedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### closeGeneralTopic()

> **closeGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5173

Closes General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseGeneralForumTopicParams`](../../../../gramio/interfaces/CloseGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeGeneralTopic`](ForumMixin.md#closegeneraltopic)

***

### closeTopic()

> **closeTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5171

Closes topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseForumTopicParams`](../../../../gramio/interfaces/CloseForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeTopic`](ForumMixin.md#closetopic)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### createTopic()

> **createTopic**(`name`, `params?`): `Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

Defined in: contexts/index.d.ts:5165

Creates a topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateForumTopicParams`](../../../../gramio/interfaces/CreateForumTopicParams.md), `"name"` | `"chat_id"`> |

#### Returns

`Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`createTopic`](ForumMixin.md#createtopic)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### deleteTopic()

> **deleteTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5179

Deletes topic along with all its messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteForumTopicParams`](../../../../gramio/interfaces/DeleteForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`deleteTopic`](ForumMixin.md#deletetopic)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editGeneralTopic()

> **editGeneralTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5169

Edits General topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditGeneralForumTopicParams`](../../../../gramio/interfaces/EditGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editGeneralTopic`](ForumMixin.md#editgeneraltopic)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### editTopic()

> **editTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5167

Edits topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditForumTopicParams`](../../../../gramio/interfaces/EditForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editTopic`](ForumMixin.md#edittopic)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

Defined in: contexts/index.d.ts:5163

Returns custom emoji stickers, which can be used as a forum topic icon by any user

#### Returns

`Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`getTopicIcons`](ForumMixin.md#gettopicicons)

***

### hasFrom()

> **hasFrom**(): this is Require\<ForumTopicCreatedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ForumTopicCreatedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasIconCustomEmojiId()

> **hasIconCustomEmojiId**(): `this is Require<ForumTopicCreatedContext<Bot>, "iconCustomEmojiId">`

Defined in: contexts/index.d.ts:5700

Checks whether the event has `iconCustomEmojiId` property

#### Returns

`this is Require<ForumTopicCreatedContext<Bot>, "iconCustomEmojiId">`

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ForumTopicCreatedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ForumTopicCreatedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### hideGeneralTopic()

> **hideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5185

Hides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`HideGeneralForumTopicParams`](../../../../gramio/interfaces/HideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`hideGeneralTopic`](ForumMixin.md#hidegeneraltopic)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ForumTopicCreatedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ForumTopicCreatedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGeneralTopic()

> **isGeneralTopic**(): `this is RequireValue<ForumTopicCreatedContext<Bot>, "threadId", undefined>`

Defined in: contexts/index.d.ts:5161

Checks whether this topic is actually a 'General' one

#### Returns

`this is RequireValue<ForumTopicCreatedContext<Bot>, "threadId", undefined>`

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`isGeneralTopic`](ForumMixin.md#isgeneraltopic)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ForumTopicCreatedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ForumTopicCreatedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<ForumTopicCreatedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ForumTopicCreatedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ForumTopicCreatedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ForumTopicCreatedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reopenGeneralTopic()

> **reopenGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5177

Reopens General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenGeneralForumTopicParams`](../../../../gramio/interfaces/ReopenGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenGeneralTopic`](ForumMixin.md#reopengeneraltopic)

***

### reopenTopic()

> **reopenTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5175

Reopens topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenForumTopicParams`](../../../../gramio/interfaces/ReopenForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenTopic`](ForumMixin.md#reopentopic)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unhideGeneralTopic()

> **unhideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5187

Unhides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnhideGeneralForumTopicParams`](../../../../gramio/interfaces/UnhideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unhideGeneralTopic`](ForumMixin.md#unhidegeneraltopic)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinAllGeneralTopicMessages()

> **unpinAllGeneralTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5183

Clears the list of pinned messages in a General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllGeneralForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllGeneralForumTopicMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllGeneralTopicMessages`](ForumMixin.md#unpinallgeneraltopicmessages)

***

### unpinAllTopicMessages()

> **unpinAllTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5181

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllForumTopicMessagesParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllTopicMessages`](ForumMixin.md#unpinalltopicmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ForumTopicEdited.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ForumTopicEdited

# Class: ForumTopicEdited

Defined in: contexts/index.d.ts:1911

This object represents a service message about an edited forum topic.

## Constructors

### Constructor

> **new ForumTopicEdited**(`payload`): `ForumTopicEdited`

Defined in: contexts/index.d.ts:1913

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramForumTopicEdited`](../../../../gramio/interfaces/TelegramForumTopicEdited.md) |

#### Returns

`ForumTopicEdited`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramForumTopicEdited`](../../../../gramio/interfaces/TelegramForumTopicEdited.md) | contexts/index.d.ts:1912 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1915

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### iconCustomEmojiId

#### Get Signature

> **get** **iconCustomEmojiId**(): `string`

Defined in: contexts/index.d.ts:1919

New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed

##### Returns

`string`

***

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: contexts/index.d.ts:1917

New name of the topic, if it was edited

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/ForumTopicEditedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ForumTopicEditedContext

# Class: ForumTopicEditedContext\<Bot>

Defined in: contexts/index.d.ts:5712

This object represents a service message about an edited forum topic.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ForumTopicEditedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ForumMixin`](ForumMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ForumTopicEditedContext`<`Bot`>, `ForumTopicEditedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ForumTopicEditedContext**<`Bot`>(`options`): `ForumTopicEditedContext`<`Bot`>

Defined in: contexts/index.d.ts:5716

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ForumTopicEditedContextOptions`<`Bot`> |

#### Returns

`ForumTopicEditedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ForumTopicEditedContext**(...`args`): `ForumTopicEditedContext`

Defined in: contexts/index.d.ts:5712

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ForumTopicEditedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5714 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### iconCustomEmojiId

#### Get Signature

> **get** **iconCustomEmojiId**(): `string`

Defined in: contexts/index.d.ts:5722

New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed

##### Returns

`string`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: contexts/index.d.ts:5718

New name of the topic, if it was edited

##### Returns

`string`

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `ForumTopicEditedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ForumTopicEditedContextOptions` |

#### Returns

`ForumTopicEditedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### closeGeneralTopic()

> **closeGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5173

Closes General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseGeneralForumTopicParams`](../../../../gramio/interfaces/CloseGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeGeneralTopic`](ForumMixin.md#closegeneraltopic)

***

### closeTopic()

> **closeTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5171

Closes topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseForumTopicParams`](../../../../gramio/interfaces/CloseForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeTopic`](ForumMixin.md#closetopic)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### createTopic()

> **createTopic**(`name`, `params?`): `Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

Defined in: contexts/index.d.ts:5165

Creates a topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateForumTopicParams`](../../../../gramio/interfaces/CreateForumTopicParams.md), `"name"` | `"chat_id"`> |

#### Returns

`Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`createTopic`](ForumMixin.md#createtopic)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### deleteTopic()

> **deleteTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5179

Deletes topic along with all its messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteForumTopicParams`](../../../../gramio/interfaces/DeleteForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`deleteTopic`](ForumMixin.md#deletetopic)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editGeneralTopic()

> **editGeneralTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5169

Edits General topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditGeneralForumTopicParams`](../../../../gramio/interfaces/EditGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editGeneralTopic`](ForumMixin.md#editgeneraltopic)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### editTopic()

> **editTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5167

Edits topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditForumTopicParams`](../../../../gramio/interfaces/EditForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editTopic`](ForumMixin.md#edittopic)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

Defined in: contexts/index.d.ts:5163

Returns custom emoji stickers, which can be used as a forum topic icon by any user

#### Returns

`Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`getTopicIcons`](ForumMixin.md#gettopicicons)

***

### hasFrom()

> **hasFrom**(): this is Require\<ForumTopicEditedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ForumTopicEditedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasIconCustomEmojiId()

> **hasIconCustomEmojiId**(): `this is Require<ForumTopicEditedContext<Bot>, "iconCustomEmojiId">`

Defined in: contexts/index.d.ts:5724

Checks whether the `iconCustomEmojiId` property has been edited

#### Returns

`this is Require<ForumTopicEditedContext<Bot>, "iconCustomEmojiId">`

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasName()

> **hasName**(): `this is Require<ForumTopicEditedContext<Bot>, "name">`

Defined in: contexts/index.d.ts:5720

Checks whether the `name` property has been edited

#### Returns

`this is Require<ForumTopicEditedContext<Bot>, "name">`

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ForumTopicEditedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ForumTopicEditedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### hideGeneralTopic()

> **hideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5185

Hides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`HideGeneralForumTopicParams`](../../../../gramio/interfaces/HideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`hideGeneralTopic`](ForumMixin.md#hidegeneraltopic)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ForumTopicEditedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ForumTopicEditedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGeneralTopic()

> **isGeneralTopic**(): `this is RequireValue<ForumTopicEditedContext<Bot>, "threadId", undefined>`

Defined in: contexts/index.d.ts:5161

Checks whether this topic is actually a 'General' one

#### Returns

`this is RequireValue<ForumTopicEditedContext<Bot>, "threadId", undefined>`

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`isGeneralTopic`](ForumMixin.md#isgeneraltopic)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ForumTopicEditedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ForumTopicEditedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<ForumTopicEditedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ForumTopicEditedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ForumTopicEditedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ForumTopicEditedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reopenGeneralTopic()

> **reopenGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5177

Reopens General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenGeneralForumTopicParams`](../../../../gramio/interfaces/ReopenGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenGeneralTopic`](ForumMixin.md#reopengeneraltopic)

***

### reopenTopic()

> **reopenTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5175

Reopens topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenForumTopicParams`](../../../../gramio/interfaces/ReopenForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenTopic`](ForumMixin.md#reopentopic)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unhideGeneralTopic()

> **unhideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5187

Unhides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnhideGeneralForumTopicParams`](../../../../gramio/interfaces/UnhideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unhideGeneralTopic`](ForumMixin.md#unhidegeneraltopic)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinAllGeneralTopicMessages()

> **unpinAllGeneralTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5183

Clears the list of pinned messages in a General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllGeneralForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllGeneralForumTopicMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllGeneralTopicMessages`](ForumMixin.md#unpinallgeneraltopicmessages)

***

### unpinAllTopicMessages()

> **unpinAllTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5181

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllForumTopicMessagesParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllTopicMessages`](ForumMixin.md#unpinalltopicmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ForumTopicReopened.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ForumTopicReopened

# Class: ForumTopicReopened

Defined in: contexts/index.d.ts:1923

This object represents a service message about an edited forum topic.

## Constructors

### Constructor

> **new ForumTopicReopened**(`payload`): `ForumTopicReopened`

Defined in: contexts/index.d.ts:1925

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramForumTopicReopened`](../../../../gramio/interfaces/TelegramForumTopicReopened.md) |

#### Returns

`ForumTopicReopened`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramForumTopicReopened`](../../../../gramio/interfaces/TelegramForumTopicReopened.md) | contexts/index.d.ts:1924 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1927

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/ForumTopicReopenedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ForumTopicReopenedContext

# Class: ForumTopicReopenedContext\<Bot>

Defined in: contexts/index.d.ts:5736

This object represents a service message about a forum topic reopened in the chat. Currently holds no information.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ForumTopicReopenedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ForumMixin`](ForumMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ForumTopicReopenedContext`<`Bot`>, `ForumTopicReopenedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ForumTopicReopenedContext**<`Bot`>(`options`): `ForumTopicReopenedContext`<`Bot`>

Defined in: contexts/index.d.ts:5739

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ForumTopicReopenedContextOptions`<`Bot`> |

#### Returns

`ForumTopicReopenedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ForumTopicReopenedContext**(...`args`): `ForumTopicReopenedContext`

Defined in: contexts/index.d.ts:5736

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ForumTopicReopenedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5738 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `ForumTopicReopenedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ForumTopicReopenedContextOptions` |

#### Returns

`ForumTopicReopenedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### closeGeneralTopic()

> **closeGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5173

Closes General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseGeneralForumTopicParams`](../../../../gramio/interfaces/CloseGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeGeneralTopic`](ForumMixin.md#closegeneraltopic)

***

### closeTopic()

> **closeTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5171

Closes topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseForumTopicParams`](../../../../gramio/interfaces/CloseForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeTopic`](ForumMixin.md#closetopic)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### createTopic()

> **createTopic**(`name`, `params?`): `Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

Defined in: contexts/index.d.ts:5165

Creates a topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateForumTopicParams`](../../../../gramio/interfaces/CreateForumTopicParams.md), `"name"` | `"chat_id"`> |

#### Returns

`Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`createTopic`](ForumMixin.md#createtopic)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### deleteTopic()

> **deleteTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5179

Deletes topic along with all its messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteForumTopicParams`](../../../../gramio/interfaces/DeleteForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`deleteTopic`](ForumMixin.md#deletetopic)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editGeneralTopic()

> **editGeneralTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5169

Edits General topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditGeneralForumTopicParams`](../../../../gramio/interfaces/EditGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editGeneralTopic`](ForumMixin.md#editgeneraltopic)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### editTopic()

> **editTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5167

Edits topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditForumTopicParams`](../../../../gramio/interfaces/EditForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editTopic`](ForumMixin.md#edittopic)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

Defined in: contexts/index.d.ts:5163

Returns custom emoji stickers, which can be used as a forum topic icon by any user

#### Returns

`Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`getTopicIcons`](ForumMixin.md#gettopicicons)

***

### hasFrom()

> **hasFrom**(): this is Require\<ForumTopicReopenedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ForumTopicReopenedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ForumTopicReopenedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ForumTopicReopenedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### hideGeneralTopic()

> **hideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5185

Hides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`HideGeneralForumTopicParams`](../../../../gramio/interfaces/HideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`hideGeneralTopic`](ForumMixin.md#hidegeneraltopic)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ForumTopicReopenedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ForumTopicReopenedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGeneralTopic()

> **isGeneralTopic**(): `this is RequireValue<ForumTopicReopenedContext<Bot>, "threadId", undefined>`

Defined in: contexts/index.d.ts:5741

Checks whether this topic is actually a 'General' one

#### Returns

`this is RequireValue<ForumTopicReopenedContext<Bot>, "threadId", undefined>`

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`isGeneralTopic`](ForumMixin.md#isgeneraltopic)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ForumTopicReopenedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ForumTopicReopenedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<ForumTopicReopenedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ForumTopicReopenedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ForumTopicReopenedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ForumTopicReopenedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reopenGeneralTopic()

> **reopenGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5177

Reopens General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenGeneralForumTopicParams`](../../../../gramio/interfaces/ReopenGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenGeneralTopic`](ForumMixin.md#reopengeneraltopic)

***

### reopenTopic()

> **reopenTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5175

Reopens topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenForumTopicParams`](../../../../gramio/interfaces/ReopenForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenTopic`](ForumMixin.md#reopentopic)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unhideGeneralTopic()

> **unhideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5187

Unhides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnhideGeneralForumTopicParams`](../../../../gramio/interfaces/UnhideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unhideGeneralTopic`](ForumMixin.md#unhidegeneraltopic)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinAllGeneralTopicMessages()

> **unpinAllGeneralTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5183

Clears the list of pinned messages in a General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllGeneralForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllGeneralForumTopicMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllGeneralTopicMessages`](ForumMixin.md#unpinallgeneraltopicmessages)

***

### unpinAllTopicMessages()

> **unpinAllTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5181

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllForumTopicMessagesParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllTopicMessages`](ForumMixin.md#unpinalltopicmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/Game.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Game

# Class: Game

Defined in: contexts/index.d.ts:1543

This object represents a game.

## Constructors

### Constructor

> **new Game**(`payload`): `Game`

Defined in: contexts/index.d.ts:1545

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramGame`](../../../../gramio/interfaces/TelegramGame.md) |

#### Returns

`Game`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramGame`](../../../../gramio/interfaces/TelegramGame.md) | contexts/index.d.ts:1544 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1547

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:1570

Animation that will be displayed in the game message in chats.
Upload via BotFather

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

***

### description

#### Get Signature

> **get** **description**(): `string`

Defined in: contexts/index.d.ts:1551

Description of the game

##### Returns

`string`

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:1553

Photo that will be displayed in the game message in chats.

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:1560

Brief description of the game or high scores included in the game message
Can be automatically edited to include current high scores for the game
when the bot calls `setGameScore`, or manually edited using
`editMessageText`. 0-4096 characters.

##### Returns

`string`

***

### textEntities

#### Get Signature

> **get** **textEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:1565

Special entities that appear in text, such as usernames, URLs, bot
commands, etc.

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:1549

Title of the game

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/GeneralForumTopicHidden.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GeneralForumTopicHidden

# Class: GeneralForumTopicHidden

Defined in: contexts/index.d.ts:1931

This object represents a service message about General forum topic hidden in the chat. Currently holds no information.

## Constructors

### Constructor

> **new GeneralForumTopicHidden**(`payload`): `GeneralForumTopicHidden`

Defined in: contexts/index.d.ts:1933

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramGeneralForumTopicHidden`](../../../../gramio/interfaces/TelegramGeneralForumTopicHidden.md) |

#### Returns

`GeneralForumTopicHidden`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramGeneralForumTopicHidden`](../../../../gramio/interfaces/TelegramGeneralForumTopicHidden.md) | contexts/index.d.ts:1932 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1935

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/GeneralForumTopicHiddenContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GeneralForumTopicHiddenContext

# Class: GeneralForumTopicHiddenContext\<Bot>

Defined in: contexts/index.d.ts:5753

This object represents a service message about General forum topic hidden in the chat. Currently holds no information.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`GeneralForumTopicHiddenContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ForumMixin`](ForumMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `GeneralForumTopicHiddenContext`<`Bot`>, `GeneralForumTopicHiddenContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new GeneralForumTopicHiddenContext**<`Bot`>(`options`): `GeneralForumTopicHiddenContext`<`Bot`>

Defined in: contexts/index.d.ts:5756

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `GeneralForumTopicHiddenContextOptions`<`Bot`> |

#### Returns

`GeneralForumTopicHiddenContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new GeneralForumTopicHiddenContext**(...`args`): `GeneralForumTopicHiddenContext`

Defined in: contexts/index.d.ts:5753

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`GeneralForumTopicHiddenContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5755 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `GeneralForumTopicHiddenContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `GeneralForumTopicHiddenContextOptions` |

#### Returns

`GeneralForumTopicHiddenContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### closeGeneralTopic()

> **closeGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5173

Closes General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseGeneralForumTopicParams`](../../../../gramio/interfaces/CloseGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeGeneralTopic`](ForumMixin.md#closegeneraltopic)

***

### closeTopic()

> **closeTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5171

Closes topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseForumTopicParams`](../../../../gramio/interfaces/CloseForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeTopic`](ForumMixin.md#closetopic)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### createTopic()

> **createTopic**(`name`, `params?`): `Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

Defined in: contexts/index.d.ts:5165

Creates a topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateForumTopicParams`](../../../../gramio/interfaces/CreateForumTopicParams.md), `"name"` | `"chat_id"`> |

#### Returns

`Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`createTopic`](ForumMixin.md#createtopic)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### deleteTopic()

> **deleteTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5179

Deletes topic along with all its messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteForumTopicParams`](../../../../gramio/interfaces/DeleteForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`deleteTopic`](ForumMixin.md#deletetopic)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editGeneralTopic()

> **editGeneralTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5169

Edits General topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditGeneralForumTopicParams`](../../../../gramio/interfaces/EditGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editGeneralTopic`](ForumMixin.md#editgeneraltopic)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### editTopic()

> **editTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5167

Edits topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditForumTopicParams`](../../../../gramio/interfaces/EditForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editTopic`](ForumMixin.md#edittopic)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

Defined in: contexts/index.d.ts:5163

Returns custom emoji stickers, which can be used as a forum topic icon by any user

#### Returns

`Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`getTopicIcons`](ForumMixin.md#gettopicicons)

***

### hasFrom()

> **hasFrom**(): this is Require\<GeneralForumTopicHiddenContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<GeneralForumTopicHiddenContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<GeneralForumTopicHiddenContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<GeneralForumTopicHiddenContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### hideGeneralTopic()

> **hideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5185

Hides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`HideGeneralForumTopicParams`](../../../../gramio/interfaces/HideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`hideGeneralTopic`](ForumMixin.md#hidegeneraltopic)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<GeneralForumTopicHiddenContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<GeneralForumTopicHiddenContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGeneralTopic()

> **isGeneralTopic**(): `this is RequireValue<GeneralForumTopicHiddenContext<Bot>, "threadId", undefined>`

Defined in: contexts/index.d.ts:5758

Checks whether this topic is actually a 'General' one

#### Returns

`this is RequireValue<GeneralForumTopicHiddenContext<Bot>, "threadId", undefined>`

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`isGeneralTopic`](ForumMixin.md#isgeneraltopic)

***

### isGroup()

> **isGroup**(): `this is RequireValue<GeneralForumTopicHiddenContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<GeneralForumTopicHiddenContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<GeneralForumTopicHiddenContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<GeneralForumTopicHiddenContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<GeneralForumTopicHiddenContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<GeneralForumTopicHiddenContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reopenGeneralTopic()

> **reopenGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5177

Reopens General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenGeneralForumTopicParams`](../../../../gramio/interfaces/ReopenGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenGeneralTopic`](ForumMixin.md#reopengeneraltopic)

***

### reopenTopic()

> **reopenTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5175

Reopens topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenForumTopicParams`](../../../../gramio/interfaces/ReopenForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenTopic`](ForumMixin.md#reopentopic)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unhideGeneralTopic()

> **unhideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5187

Unhides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnhideGeneralForumTopicParams`](../../../../gramio/interfaces/UnhideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unhideGeneralTopic`](ForumMixin.md#unhidegeneraltopic)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinAllGeneralTopicMessages()

> **unpinAllGeneralTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5183

Clears the list of pinned messages in a General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllGeneralForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllGeneralForumTopicMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllGeneralTopicMessages`](ForumMixin.md#unpinallgeneraltopicmessages)

***

### unpinAllTopicMessages()

> **unpinAllTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5181

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllForumTopicMessagesParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllTopicMessages`](ForumMixin.md#unpinalltopicmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/GeneralForumTopicUnhidden.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GeneralForumTopicUnhidden

# Class: GeneralForumTopicUnhidden

Defined in: contexts/index.d.ts:1939

This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.

## Constructors

### Constructor

> **new GeneralForumTopicUnhidden**(`payload`): `GeneralForumTopicUnhidden`

Defined in: contexts/index.d.ts:1941

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramGeneralForumTopicUnhidden`](../../../../gramio/interfaces/TelegramGeneralForumTopicUnhidden.md) |

#### Returns

`GeneralForumTopicUnhidden`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramGeneralForumTopicUnhidden`](../../../../gramio/interfaces/TelegramGeneralForumTopicUnhidden.md) | contexts/index.d.ts:1940 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1943

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/GeneralForumTopicUnhiddenContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GeneralForumTopicUnhiddenContext

# Class: GeneralForumTopicUnhiddenContext\<Bot>

Defined in: contexts/index.d.ts:5770

This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`GeneralForumTopicUnhiddenContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ForumMixin`](ForumMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `GeneralForumTopicUnhiddenContext`<`Bot`>, `GeneralForumTopicUnhiddenContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new GeneralForumTopicUnhiddenContext**<`Bot`>(`options`): `GeneralForumTopicUnhiddenContext`<`Bot`>

Defined in: contexts/index.d.ts:5773

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `GeneralForumTopicUnhiddenContextOptions`<`Bot`> |

#### Returns

`GeneralForumTopicUnhiddenContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new GeneralForumTopicUnhiddenContext**(...`args`): `GeneralForumTopicUnhiddenContext`

Defined in: contexts/index.d.ts:5770

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`GeneralForumTopicUnhiddenContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5772 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `GeneralForumTopicUnhiddenContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `GeneralForumTopicUnhiddenContextOptions` |

#### Returns

`GeneralForumTopicUnhiddenContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### closeGeneralTopic()

> **closeGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5173

Closes General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseGeneralForumTopicParams`](../../../../gramio/interfaces/CloseGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeGeneralTopic`](ForumMixin.md#closegeneraltopic)

***

### closeTopic()

> **closeTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5171

Closes topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseForumTopicParams`](../../../../gramio/interfaces/CloseForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeTopic`](ForumMixin.md#closetopic)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### createTopic()

> **createTopic**(`name`, `params?`): `Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

Defined in: contexts/index.d.ts:5165

Creates a topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateForumTopicParams`](../../../../gramio/interfaces/CreateForumTopicParams.md), `"name"` | `"chat_id"`> |

#### Returns

`Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`createTopic`](ForumMixin.md#createtopic)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### deleteTopic()

> **deleteTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5179

Deletes topic along with all its messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteForumTopicParams`](../../../../gramio/interfaces/DeleteForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`deleteTopic`](ForumMixin.md#deletetopic)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editGeneralTopic()

> **editGeneralTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5169

Edits General topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditGeneralForumTopicParams`](../../../../gramio/interfaces/EditGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editGeneralTopic`](ForumMixin.md#editgeneraltopic)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### editTopic()

> **editTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5167

Edits topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditForumTopicParams`](../../../../gramio/interfaces/EditForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editTopic`](ForumMixin.md#edittopic)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

Defined in: contexts/index.d.ts:5163

Returns custom emoji stickers, which can be used as a forum topic icon by any user

#### Returns

`Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`getTopicIcons`](ForumMixin.md#gettopicicons)

***

### hasFrom()

> **hasFrom**(): this is Require\<GeneralForumTopicUnhiddenContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<GeneralForumTopicUnhiddenContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<GeneralForumTopicUnhiddenContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<GeneralForumTopicUnhiddenContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### hideGeneralTopic()

> **hideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5185

Hides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`HideGeneralForumTopicParams`](../../../../gramio/interfaces/HideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`hideGeneralTopic`](ForumMixin.md#hidegeneraltopic)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<GeneralForumTopicUnhiddenContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<GeneralForumTopicUnhiddenContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGeneralTopic()

> **isGeneralTopic**(): `this is RequireValue<GeneralForumTopicUnhiddenContext<Bot>, "threadId", undefined>`

Defined in: contexts/index.d.ts:5775

Checks whether this topic is actually a 'General' one

#### Returns

`this is RequireValue<GeneralForumTopicUnhiddenContext<Bot>, "threadId", undefined>`

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`isGeneralTopic`](ForumMixin.md#isgeneraltopic)

***

### isGroup()

> **isGroup**(): `this is RequireValue<GeneralForumTopicUnhiddenContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<GeneralForumTopicUnhiddenContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<GeneralForumTopicUnhiddenContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<GeneralForumTopicUnhiddenContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<GeneralForumTopicUnhiddenContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<GeneralForumTopicUnhiddenContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reopenGeneralTopic()

> **reopenGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5177

Reopens General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenGeneralForumTopicParams`](../../../../gramio/interfaces/ReopenGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenGeneralTopic`](ForumMixin.md#reopengeneraltopic)

***

### reopenTopic()

> **reopenTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5175

Reopens topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenForumTopicParams`](../../../../gramio/interfaces/ReopenForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenTopic`](ForumMixin.md#reopentopic)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unhideGeneralTopic()

> **unhideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5187

Unhides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnhideGeneralForumTopicParams`](../../../../gramio/interfaces/UnhideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unhideGeneralTopic`](ForumMixin.md#unhidegeneraltopic)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinAllGeneralTopicMessages()

> **unpinAllGeneralTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5183

Clears the list of pinned messages in a General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllGeneralForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllGeneralForumTopicMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllGeneralTopicMessages`](ForumMixin.md#unpinallgeneraltopicmessages)

***

### unpinAllTopicMessages()

> **unpinAllTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5181

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllForumTopicMessagesParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllTopicMessages`](ForumMixin.md#unpinalltopicmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/Gift.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Gift

# Class: Gift

Defined in: contexts/index.d.ts:2563

Describes a service message about a regular gift that was sent or received.

[Documentation](https://core.telegram.org/bots/api/#giftinfo)

## Constructors

### Constructor

> **new Gift**(`payload`): `Gift`

Defined in: contexts/index.d.ts:2565

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramGift`](../../../../gramio/interfaces/TelegramGift.md) |

#### Returns

`Gift`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramGift`](../../../../gramio/interfaces/TelegramGift.md) | contexts/index.d.ts:2564 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2567

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### background

#### Get Signature

> **get** **background**(): [`GiftBackground`](GiftBackground.md)

Defined in: contexts/index.d.ts:2587

*Optional*. Background of the gift

##### Returns

[`GiftBackground`](GiftBackground.md)

***

### hasColors

#### Get Signature

> **get** **hasColors**(): `true`

Defined in: contexts/index.d.ts:2581

*Optional*. True, if the gift can be used (after being upgraded) to customize a user's appearance

##### Returns

`true`

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:2591

Information about the gift

##### Returns

`string`

***

### isPremium

#### Get Signature

> **get** **isPremium**(): `true`

Defined in: contexts/index.d.ts:2579

*Optional*. True, if the gift can only be purchased by Telegram Premium subscribers

##### Returns

`true`

***

### personalRemainingCount

#### Get Signature

> **get** **personalRemainingCount**(): `number`

Defined in: contexts/index.d.ts:2585

*Optional*. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only

##### Returns

`number`

***

### personalTotalCount

#### Get Signature

> **get** **personalTotalCount**(): `number`

Defined in: contexts/index.d.ts:2583

*Optional*. The total number of gifts of this type that can be sent by the bot; for limited gifts only

##### Returns

`number`

***

### publisherChat

#### Get Signature

> **get** **publisherChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2593

*Optional*. Information about the chat that published the gift

##### Returns

[`Chat`](Chat.md)

***

### remainingCount

#### Get Signature

> **get** **remainingCount**(): `number`

Defined in: contexts/index.d.ts:2577

The number of remaining gifts of this type that can be sent; for limited gifts only

##### Returns

`number`

***

### starCount

#### Get Signature

> **get** **starCount**(): `number`

Defined in: contexts/index.d.ts:2571

The number of Telegram Stars that must be paid to send the sticker

##### Returns

`number`

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:2569

The sticker that represents the gift

##### Returns

[`StickerAttachment`](StickerAttachment.md)

***

### totalCount

#### Get Signature

> **get** **totalCount**(): `number`

Defined in: contexts/index.d.ts:2575

The total number of the gifts of this type that can be sent; for limited gifts only

##### Returns

`number`

***

### uniqueGiftVariantCount

#### Get Signature

> **get** **uniqueGiftVariantCount**(): `number`

Defined in: contexts/index.d.ts:2589

*Optional*. The total number of different unique gifts that can be obtained by upgrading the gift

##### Returns

`number`

***

### upgradeStarCount

#### Get Signature

> **get** **upgradeStarCount**(): `number`

Defined in: contexts/index.d.ts:2573

The number of Telegram Stars that must be paid to upgrade the gift to a unique one

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/GiftBackground.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GiftBackground

# Class: GiftBackground

Defined in: contexts/index.d.ts:2540

This object describes the background of a gift.

[Documentation](https://core.telegram.org/bots/api/#giftbackground)

## Constructors

### Constructor

> **new GiftBackground**(`payload`): `GiftBackground`

Defined in: contexts/index.d.ts:2542

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramGiftBackground`](../../../../gramio/interfaces/TelegramGiftBackground.md) |

#### Returns

`GiftBackground`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramGiftBackground`](../../../../gramio/interfaces/TelegramGiftBackground.md) | contexts/index.d.ts:2541 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2543

##### Returns

`string`

***

### centerColor

#### Get Signature

> **get** **centerColor**(): `number`

Defined in: contexts/index.d.ts:2547

Center color of the background in RGB format

##### Returns

`number`

***

### edgeColor

#### Get Signature

> **get** **edgeColor**(): `number`

Defined in: contexts/index.d.ts:2551

Edge color of the background in RGB format

##### Returns

`number`

***

### textColor

#### Get Signature

> **get** **textColor**(): `number`

Defined in: contexts/index.d.ts:2555

Text color of the background in RGB format

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/GiftContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GiftContext

# Class: GiftContext\<Bot>

Defined in: contexts/index.d.ts:5823

This object contains information about the chat whose identifier was shared with the bot using a `KeyboardButtonRequestChat` button.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`GiftContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `GiftContext`<`Bot`>, `GiftContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new GiftContext**<`Bot`>(`options`): `GiftContext`<`Bot`>

Defined in: contexts/index.d.ts:5827

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `GiftContextOptions`<`Bot`> |

#### Returns

`GiftContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new GiftContext**(...`args`): `GiftContext`

Defined in: contexts/index.d.ts:5823

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`GiftContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5825 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### canBeUpgraded

#### Get Signature

> **get** **canBeUpgraded**(): `true`

Defined in: contexts/index.d.ts:5837

True, if the gift can be upgraded to a unique gift

##### Returns

`true`

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### convertStarCount

#### Get Signature

> **get** **convertStarCount**(): `number`

Defined in: contexts/index.d.ts:5833

Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible

##### Returns

`number`

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:5841

Special entities that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftInfo

#### Get Signature

> **get** **giftInfo**(): [`Gift`](Gift.md)

Defined in: contexts/index.d.ts:5829

Information about the gift

##### Returns

[`Gift`](Gift.md)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### isPrivate

#### Get Signature

> **get** **isPrivate**(): `true`

Defined in: contexts/index.d.ts:5843

True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them

##### Returns

`true`

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### ownedGiftId

#### Get Signature

> **get** **ownedGiftId**(): `string`

Defined in: contexts/index.d.ts:5831

Identifier of the received gift for the bot; only present for gifts received on behalf of business accounts

##### Returns

`string`

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### prepaidUpgradeStarCount

#### Get Signature

> **get** **prepaidUpgradeStarCount**(): `number`

Defined in: contexts/index.d.ts:5835

Number of Telegram Stars that were prepaid by the sender for the ability to upgrade the gift

##### Returns

`number`

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:5839

Text of the message that was added to the gift

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `GiftContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `GiftContextOptions` |

#### Returns

`GiftContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<GiftContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<GiftContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<GiftContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<GiftContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<GiftContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<GiftContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<GiftContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<GiftContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<GiftContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<GiftContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<GiftContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<GiftContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/GiftInfo.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GiftInfo

# Class: GiftInfo

Defined in: contexts/index.d.ts:2601

Describes a service message about a regular gift that was sent or received.

[Documentation](https://core.telegram.org/bots/api/#giftinfo)

## Constructors

### Constructor

> **new GiftInfo**(`payload`): `GiftInfo`

Defined in: contexts/index.d.ts:2603

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramGiftInfo`](../../../../gramio/interfaces/TelegramGiftInfo.md) |

#### Returns

`GiftInfo`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramGiftInfo`](../../../../gramio/interfaces/TelegramGiftInfo.md) | contexts/index.d.ts:2602 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2605

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### canBeUpgraded

#### Get Signature

> **get** **canBeUpgraded**(): `true`

Defined in: contexts/index.d.ts:2615

True, if the gift can be upgraded to a unique gift

##### Returns

`true`

***

### convertStarCount

#### Get Signature

> **get** **convertStarCount**(): `number`

Defined in: contexts/index.d.ts:2611

Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible

##### Returns

`number`

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2619

Special entities that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

***

### gift

#### Get Signature

> **get** **gift**(): [`Gift`](Gift.md)

Defined in: contexts/index.d.ts:2607

Information about the gift

##### Returns

[`Gift`](Gift.md)

***

### isPrivate

#### Get Signature

> **get** **isPrivate**(): `true`

Defined in: contexts/index.d.ts:2621

True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them

##### Returns

`true`

***

### isUpgradeSeparate

#### Get Signature

> **get** **isUpgradeSeparate**(): `true`

Defined in: contexts/index.d.ts:2623

*Optional*. True, if the gift's upgrade was purchased after the gift was sent

##### Returns

`true`

***

### ownedGiftId

#### Get Signature

> **get** **ownedGiftId**(): `string`

Defined in: contexts/index.d.ts:2609

Identifier of the received gift for the bot; only present for gifts received on behalf of business accounts

##### Returns

`string`

***

### prepaidUpgradeStarCount

#### Get Signature

> **get** **prepaidUpgradeStarCount**(): `number`

Defined in: contexts/index.d.ts:2613

Number of Telegram Stars that were prepaid by the sender for the ability to upgrade the gift

##### Returns

`number`

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2617

Text of the message that was added to the gift

##### Returns

`string`

***

### uniqueGiftNumber

#### Get Signature

> **get** **uniqueGiftNumber**(): `number`

Defined in: contexts/index.d.ts:2625

*Optional*. Unique number reserved for this gift when upgraded

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/GiftUpgradeSentContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GiftUpgradeSentContext

# Class: GiftUpgradeSentContext\<Bot>

Defined in: contexts/index.d.ts:5787

This object represents a service message about an upgrade of a gift that was purchased after the gift was sent.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`GiftUpgradeSentContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `GiftUpgradeSentContext`<`Bot`>, `GiftUpgradeSentContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new GiftUpgradeSentContext**<`Bot`>(`options`): `GiftUpgradeSentContext`<`Bot`>

Defined in: contexts/index.d.ts:5791

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `GiftUpgradeSentContextOptions`<`Bot`> |

#### Returns

`GiftUpgradeSentContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new GiftUpgradeSentContext**(...`args`): `GiftUpgradeSentContext`

Defined in: contexts/index.d.ts:5787

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`GiftUpgradeSentContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5789 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### canBeUpgraded

#### Get Signature

> **get** **canBeUpgraded**(): `true`

Defined in: contexts/index.d.ts:5801

True, if the gift can be upgraded to a unique gift

##### Returns

`true`

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### convertStarCount

#### Get Signature

> **get** **convertStarCount**(): `number`

Defined in: contexts/index.d.ts:5797

Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible

##### Returns

`number`

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:5805

Special entities that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftInfo

#### Get Signature

> **get** **giftInfo**(): [`Gift`](Gift.md)

Defined in: contexts/index.d.ts:5793

Information about the gift

##### Returns

[`Gift`](Gift.md)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### isPrivate

#### Get Signature

> **get** **isPrivate**(): `true`

Defined in: contexts/index.d.ts:5807

True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them

##### Returns

`true`

***

### isUpgradeSeparate

#### Get Signature

> **get** **isUpgradeSeparate**(): `true`

Defined in: contexts/index.d.ts:5809

True, if the gift's upgrade was purchased after the gift was sent

##### Returns

`true`

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### ownedGiftId

#### Get Signature

> **get** **ownedGiftId**(): `string`

Defined in: contexts/index.d.ts:5795

Identifier of the received gift for the bot; only present for gifts received on behalf of business accounts

##### Returns

`string`

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### prepaidUpgradeStarCount

#### Get Signature

> **get** **prepaidUpgradeStarCount**(): `number`

Defined in: contexts/index.d.ts:5799

Number of Telegram Stars that were prepaid for the ability to upgrade the gift

##### Returns

`number`

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:5803

Text of the message that was added to the gift

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### uniqueGiftNumber

#### Get Signature

> **get** **uniqueGiftNumber**(): `number`

Defined in: contexts/index.d.ts:5811

*Optional*. Unique number reserved for this gift when upgraded

##### Returns

`number`

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `GiftUpgradeSentContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `GiftUpgradeSentContextOptions` |

#### Returns

`GiftUpgradeSentContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<GiftUpgradeSentContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<GiftUpgradeSentContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<GiftUpgradeSentContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<GiftUpgradeSentContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<GiftUpgradeSentContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<GiftUpgradeSentContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<GiftUpgradeSentContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<GiftUpgradeSentContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<GiftUpgradeSentContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<GiftUpgradeSentContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<GiftUpgradeSentContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<GiftUpgradeSentContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/Giveaway.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Giveaway

# Class: Giveaway

Defined in: contexts/index.d.ts:1574

This object represents a message about a scheduled giveaway.

## Constructors

### Constructor

> **new Giveaway**(`payload`): `Giveaway`

Defined in: contexts/index.d.ts:1576

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramGiveaway`](../../../../gramio/interfaces/TelegramGiveaway.md) |

#### Returns

`Giveaway`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramGiveaway`](../../../../gramio/interfaces/TelegramGiveaway.md) | contexts/index.d.ts:1575 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1578

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### chats

#### Get Signature

> **get** **chats**(): [`Chat`](Chat.md)\[]

Defined in: contexts/index.d.ts:1580

The list of chats which the user must join to participate in the giveaway

##### Returns

[`Chat`](Chat.md)\[]

***

### countryCodes

#### Get Signature

> **get** **countryCodes**(): `string`\[]

Defined in: contexts/index.d.ts:1592

A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.

##### Returns

`string`\[]

***

### onlyNewMembers

#### Get Signature

> **get** **onlyNewMembers**(): `true`

Defined in: contexts/index.d.ts:1586

`true`, if only users who join the chats after the giveaway started should be eligible to win

##### Returns

`true`

***

### premiumSubscriptionMonthCount

#### Get Signature

> **get** **premiumSubscriptionMonthCount**(): `number`

Defined in: contexts/index.d.ts:1594

The number of months the Telegram Premium subscription won from the giveaway will be active for

##### Returns

`number`

***

### prizeDescription

#### Get Signature

> **get** **prizeDescription**(): `string`

Defined in: contexts/index.d.ts:1590

Description of additional giveaway prize

##### Returns

`string`

***

### prizeStarCount

#### Get Signature

> **get** **prizeStarCount**(): `number`

Defined in: contexts/index.d.ts:1596

The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only

##### Returns

`number`

***

### winnerCount

#### Get Signature

> **get** **winnerCount**(): `number`

Defined in: contexts/index.d.ts:1584

The number of users which are supposed to be selected as winners of the giveaway

##### Returns

`number`

***

### winnersSelectionDate

#### Get Signature

> **get** **winnersSelectionDate**(): `number`

Defined in: contexts/index.d.ts:1582

Point in time (Unix timestamp) when winners of the giveaway will be selected

##### Returns

`number`

## Methods

### hasPublicWinners()

> **hasPublicWinners**(): `true`

Defined in: contexts/index.d.ts:1588

`true`, if the list of giveaway winners will be visible to everyone

#### Returns

`true`

---

---
url: 'https://gramio.dev/api/contexts/classes/GiveawayCompleted.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GiveawayCompleted

# Class: GiveawayCompleted

Defined in: contexts/index.d.ts:2629

This object represents a service message about the completion of a giveaway without public winners.

## Constructors

### Constructor

> **new GiveawayCompleted**(`payload`): `GiveawayCompleted`

Defined in: contexts/index.d.ts:2631

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramGiveawayCompleted`](../../../../gramio/interfaces/TelegramGiveawayCompleted.md) |

#### Returns

`GiveawayCompleted`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramGiveawayCompleted`](../../../../gramio/interfaces/TelegramGiveawayCompleted.md) | contexts/index.d.ts:2630 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2633

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### isStarGiveaway

#### Get Signature

> **get** **isStarGiveaway**(): `true`

Defined in: contexts/index.d.ts:2641

*True*, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway.

##### Returns

`true`

***

### message

#### Get Signature

> **get** **message**(): [`Message`](Message.md)

Defined in: contexts/index.d.ts:2639

Message with the giveaway that was completed, if it wasn't deleted

##### Returns

[`Message`](Message.md)

***

### unclaimedPrizeCount

#### Get Signature

> **get** **unclaimedPrizeCount**(): `number`

Defined in: contexts/index.d.ts:2637

Number of undistributed prizes

##### Returns

`number`

***

### winnerCount

#### Get Signature

> **get** **winnerCount**(): `number`

Defined in: contexts/index.d.ts:2635

Number of winners in the giveaway

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/GiveawayCompletedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GiveawayCompletedContext

# Class: GiveawayCompletedContext\<Bot>

Defined in: contexts/index.d.ts:5855

This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`GiveawayCompletedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ForumMixin`](ForumMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `GiveawayCompletedContext`<`Bot`>, `GiveawayCompletedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new GiveawayCompletedContext**<`Bot`>(`options`): `GiveawayCompletedContext`<`Bot`>

Defined in: contexts/index.d.ts:5858

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `GiveawayCompletedContextOptions`<`Bot`> |

#### Returns

`GiveawayCompletedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new GiveawayCompletedContext**(...`args`): `GiveawayCompletedContext`

Defined in: contexts/index.d.ts:5855

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`GiveawayCompletedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5857 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventGiveaway

#### Get Signature

> **get** **eventGiveaway**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:5860

Giveaway completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `GiveawayCompletedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `GiveawayCompletedContextOptions` |

#### Returns

`GiveawayCompletedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### closeGeneralTopic()

> **closeGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5173

Closes General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseGeneralForumTopicParams`](../../../../gramio/interfaces/CloseGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeGeneralTopic`](ForumMixin.md#closegeneraltopic)

***

### closeTopic()

> **closeTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5171

Closes topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseForumTopicParams`](../../../../gramio/interfaces/CloseForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeTopic`](ForumMixin.md#closetopic)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### createTopic()

> **createTopic**(`name`, `params?`): `Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

Defined in: contexts/index.d.ts:5165

Creates a topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateForumTopicParams`](../../../../gramio/interfaces/CreateForumTopicParams.md), `"name"` | `"chat_id"`> |

#### Returns

`Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`createTopic`](ForumMixin.md#createtopic)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### deleteTopic()

> **deleteTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5179

Deletes topic along with all its messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteForumTopicParams`](../../../../gramio/interfaces/DeleteForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`deleteTopic`](ForumMixin.md#deletetopic)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editGeneralTopic()

> **editGeneralTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5169

Edits General topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditGeneralForumTopicParams`](../../../../gramio/interfaces/EditGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editGeneralTopic`](ForumMixin.md#editgeneraltopic)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### editTopic()

> **editTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5167

Edits topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditForumTopicParams`](../../../../gramio/interfaces/EditForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editTopic`](ForumMixin.md#edittopic)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

Defined in: contexts/index.d.ts:5163

Returns custom emoji stickers, which can be used as a forum topic icon by any user

#### Returns

`Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`getTopicIcons`](ForumMixin.md#gettopicicons)

***

### hasFrom()

> **hasFrom**(): this is Require\<GiveawayCompletedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<GiveawayCompletedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<GiveawayCompletedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<GiveawayCompletedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### hideGeneralTopic()

> **hideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5185

Hides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`HideGeneralForumTopicParams`](../../../../gramio/interfaces/HideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`hideGeneralTopic`](ForumMixin.md#hidegeneraltopic)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<GiveawayCompletedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<GiveawayCompletedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGeneralTopic()

> **isGeneralTopic**(): `this is RequireValue<GiveawayCompletedContext<Bot>, "threadId", undefined>`

Defined in: contexts/index.d.ts:5161

Checks whether this topic is actually a 'General' one

#### Returns

`this is RequireValue<GiveawayCompletedContext<Bot>, "threadId", undefined>`

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`isGeneralTopic`](ForumMixin.md#isgeneraltopic)

***

### isGroup()

> **isGroup**(): `this is RequireValue<GiveawayCompletedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<GiveawayCompletedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<GiveawayCompletedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<GiveawayCompletedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<GiveawayCompletedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<GiveawayCompletedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reopenGeneralTopic()

> **reopenGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5177

Reopens General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenGeneralForumTopicParams`](../../../../gramio/interfaces/ReopenGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenGeneralTopic`](ForumMixin.md#reopengeneraltopic)

***

### reopenTopic()

> **reopenTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5175

Reopens topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenForumTopicParams`](../../../../gramio/interfaces/ReopenForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenTopic`](ForumMixin.md#reopentopic)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unhideGeneralTopic()

> **unhideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5187

Unhides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnhideGeneralForumTopicParams`](../../../../gramio/interfaces/UnhideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unhideGeneralTopic`](ForumMixin.md#unhidegeneraltopic)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinAllGeneralTopicMessages()

> **unpinAllGeneralTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5183

Clears the list of pinned messages in a General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllGeneralForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllGeneralForumTopicMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllGeneralTopicMessages`](ForumMixin.md#unpinallgeneraltopicmessages)

***

### unpinAllTopicMessages()

> **unpinAllTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5181

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllForumTopicMessagesParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllTopicMessages`](ForumMixin.md#unpinalltopicmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/GiveawayCreated.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GiveawayCreated

# Class: GiveawayCreated

Defined in: contexts/index.d.ts:2645

This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.

## Constructors

### Constructor

> **new GiveawayCreated**(`payload`): `GiveawayCreated`

Defined in: contexts/index.d.ts:2647

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramGiveawayCreated`](../../../../gramio/interfaces/TelegramGiveawayCreated.md) |

#### Returns

`GiveawayCreated`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramGiveawayCreated`](../../../../gramio/interfaces/TelegramGiveawayCreated.md) | contexts/index.d.ts:2646 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2649

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### prizeStarCount

#### Get Signature

> **get** **prizeStarCount**(): `number`

Defined in: contexts/index.d.ts:2651

The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/GiveawayCreatedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GiveawayCreatedContext

# Class: GiveawayCreatedContext\<Bot>

Defined in: contexts/index.d.ts:5872

This object represents a service message about the creation of a scheduled giveaway.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`GiveawayCreatedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ForumMixin`](ForumMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `GiveawayCreatedContext`<`Bot`>, `GiveawayCreatedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new GiveawayCreatedContext**<`Bot`>(`options`): `GiveawayCreatedContext`<`Bot`>

Defined in: contexts/index.d.ts:5875

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `GiveawayCreatedContextOptions`<`Bot`> |

#### Returns

`GiveawayCreatedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new GiveawayCreatedContext**(...`args`): `GiveawayCreatedContext`

Defined in: contexts/index.d.ts:5872

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`GiveawayCreatedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5874 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventGiveaway

#### Get Signature

> **get** **eventGiveaway**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:5876

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `GiveawayCreatedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `GiveawayCreatedContextOptions` |

#### Returns

`GiveawayCreatedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### closeGeneralTopic()

> **closeGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5173

Closes General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseGeneralForumTopicParams`](../../../../gramio/interfaces/CloseGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeGeneralTopic`](ForumMixin.md#closegeneraltopic)

***

### closeTopic()

> **closeTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5171

Closes topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseForumTopicParams`](../../../../gramio/interfaces/CloseForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeTopic`](ForumMixin.md#closetopic)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### createTopic()

> **createTopic**(`name`, `params?`): `Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

Defined in: contexts/index.d.ts:5165

Creates a topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateForumTopicParams`](../../../../gramio/interfaces/CreateForumTopicParams.md), `"name"` | `"chat_id"`> |

#### Returns

`Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`createTopic`](ForumMixin.md#createtopic)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### deleteTopic()

> **deleteTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5179

Deletes topic along with all its messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteForumTopicParams`](../../../../gramio/interfaces/DeleteForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`deleteTopic`](ForumMixin.md#deletetopic)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editGeneralTopic()

> **editGeneralTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5169

Edits General topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditGeneralForumTopicParams`](../../../../gramio/interfaces/EditGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editGeneralTopic`](ForumMixin.md#editgeneraltopic)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### editTopic()

> **editTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5167

Edits topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditForumTopicParams`](../../../../gramio/interfaces/EditForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editTopic`](ForumMixin.md#edittopic)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

Defined in: contexts/index.d.ts:5163

Returns custom emoji stickers, which can be used as a forum topic icon by any user

#### Returns

`Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`getTopicIcons`](ForumMixin.md#gettopicicons)

***

### hasFrom()

> **hasFrom**(): this is Require\<GiveawayCreatedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<GiveawayCreatedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<GiveawayCreatedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<GiveawayCreatedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### hideGeneralTopic()

> **hideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5185

Hides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`HideGeneralForumTopicParams`](../../../../gramio/interfaces/HideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`hideGeneralTopic`](ForumMixin.md#hidegeneraltopic)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<GiveawayCreatedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<GiveawayCreatedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGeneralTopic()

> **isGeneralTopic**(): `this is RequireValue<GiveawayCreatedContext<Bot>, "threadId", undefined>`

Defined in: contexts/index.d.ts:5161

Checks whether this topic is actually a 'General' one

#### Returns

`this is RequireValue<GiveawayCreatedContext<Bot>, "threadId", undefined>`

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`isGeneralTopic`](ForumMixin.md#isgeneraltopic)

***

### isGroup()

> **isGroup**(): `this is RequireValue<GiveawayCreatedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<GiveawayCreatedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<GiveawayCreatedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<GiveawayCreatedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<GiveawayCreatedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<GiveawayCreatedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reopenGeneralTopic()

> **reopenGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5177

Reopens General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenGeneralForumTopicParams`](../../../../gramio/interfaces/ReopenGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenGeneralTopic`](ForumMixin.md#reopengeneraltopic)

***

### reopenTopic()

> **reopenTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5175

Reopens topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenForumTopicParams`](../../../../gramio/interfaces/ReopenForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenTopic`](ForumMixin.md#reopentopic)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unhideGeneralTopic()

> **unhideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5187

Unhides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnhideGeneralForumTopicParams`](../../../../gramio/interfaces/UnhideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unhideGeneralTopic`](ForumMixin.md#unhidegeneraltopic)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinAllGeneralTopicMessages()

> **unpinAllGeneralTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5183

Clears the list of pinned messages in a General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllGeneralForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllGeneralForumTopicMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllGeneralTopicMessages`](ForumMixin.md#unpinallgeneraltopicmessages)

***

### unpinAllTopicMessages()

> **unpinAllTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5181

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllForumTopicMessagesParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllTopicMessages`](ForumMixin.md#unpinalltopicmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/GiveawayWinners.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GiveawayWinners

# Class: GiveawayWinners

Defined in: contexts/index.d.ts:1600

This object represents a message about the completion of a giveaway with public winners.

## Constructors

### Constructor

> **new GiveawayWinners**(`payload`): `GiveawayWinners`

Defined in: contexts/index.d.ts:1602

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramGiveawayWinners`](../../../../gramio/interfaces/TelegramGiveawayWinners.md) |

#### Returns

`GiveawayWinners`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramGiveawayWinners`](../../../../gramio/interfaces/TelegramGiveawayWinners.md) | contexts/index.d.ts:1601 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1604

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### additionalChatCount

#### Get Signature

> **get** **additionalChatCount**(): `number`

Defined in: contexts/index.d.ts:1616

The number of other chats the user had to join in order to be eligible for the giveaway

##### Returns

`number`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:1606

The chat that created the giveaway

##### Returns

[`Chat`](Chat.md)

***

### messageId

#### Get Signature

> **get** **messageId**(): `number`

Defined in: contexts/index.d.ts:1608

Identifier of the message with the giveaway in the chat

##### Returns

`number`

***

### onlyNewMembers

#### Get Signature

> **get** **onlyNewMembers**(): `true`

Defined in: contexts/index.d.ts:1622

`true`, if only users who had joined the chats after the giveaway started were eligible to win

##### Returns

`true`

***

### premiumSubscriptionMonthCount

#### Get Signature

> **get** **premiumSubscriptionMonthCount**(): `number`

Defined in: contexts/index.d.ts:1618

The number of months the Telegram Premium subscription won from the giveaway will be active for

##### Returns

`number`

***

### prizeDescription

#### Get Signature

> **get** **prizeDescription**(): `string`

Defined in: contexts/index.d.ts:1626

Description of additional giveaway prize

##### Returns

`string`

***

### prizeStarCount

#### Get Signature

> **get** **prizeStarCount**(): `number`

Defined in: contexts/index.d.ts:1628

The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only

##### Returns

`number`

***

### unclaimedPrizeCount

#### Get Signature

> **get** **unclaimedPrizeCount**(): `number`

Defined in: contexts/index.d.ts:1620

Number of undistributed prizes

##### Returns

`number`

***

### winnerCount

#### Get Signature

> **get** **winnerCount**(): `number`

Defined in: contexts/index.d.ts:1612

Total number of winners in the giveaway

##### Returns

`number`

***

### winners

#### Get Signature

> **get** **winners**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:1614

List of up to 100 winners of the giveaway

##### Returns

[`User`](User.md)\[]

***

### winnersSelectionDate

#### Get Signature

> **get** **winnersSelectionDate**(): `number`

Defined in: contexts/index.d.ts:1610

Point in time (Unix timestamp) when winners of the giveaway were selected

##### Returns

`number`

## Methods

### wasRefunded()

> **wasRefunded**(): `true`

Defined in: contexts/index.d.ts:1624

`true`, if the giveaway was canceled because the payment for it was refunded

#### Returns

`true`

---

---
url: 'https://gramio.dev/api/contexts/classes/GiveawayWinnersContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GiveawayWinnersContext

# Class: GiveawayWinnersContext\<Bot>

Defined in: contexts/index.d.ts:5888

This object represents a message about the completion of a giveaway with public winners.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`GiveawayWinnersContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ForumMixin`](ForumMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `GiveawayWinnersContext`<`Bot`>, `GiveawayWinnersContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new GiveawayWinnersContext**<`Bot`>(`options`): `GiveawayWinnersContext`<`Bot`>

Defined in: contexts/index.d.ts:5891

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `GiveawayWinnersContextOptions`<`Bot`> |

#### Returns

`GiveawayWinnersContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new GiveawayWinnersContext**(...`args`): `GiveawayWinnersContext`

Defined in: contexts/index.d.ts:5888

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`GiveawayWinnersContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5890 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventGiveaway

#### Get Signature

> **get** **eventGiveaway**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:5893

Giveaway winners

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `GiveawayWinnersContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `GiveawayWinnersContextOptions` |

#### Returns

`GiveawayWinnersContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### closeGeneralTopic()

> **closeGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5173

Closes General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseGeneralForumTopicParams`](../../../../gramio/interfaces/CloseGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeGeneralTopic`](ForumMixin.md#closegeneraltopic)

***

### closeTopic()

> **closeTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5171

Closes topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CloseForumTopicParams`](../../../../gramio/interfaces/CloseForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`closeTopic`](ForumMixin.md#closetopic)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### createTopic()

> **createTopic**(`name`, `params?`): `Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

Defined in: contexts/index.d.ts:5165

Creates a topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateForumTopicParams`](../../../../gramio/interfaces/CreateForumTopicParams.md), `"name"` | `"chat_id"`> |

#### Returns

`Promise`<[`TelegramForumTopic`](../../../../gramio/interfaces/TelegramForumTopic.md)>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`createTopic`](ForumMixin.md#createtopic)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### deleteTopic()

> **deleteTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5179

Deletes topic along with all its messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteForumTopicParams`](../../../../gramio/interfaces/DeleteForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`deleteTopic`](ForumMixin.md#deletetopic)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editGeneralTopic()

> **editGeneralTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5169

Edits General topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditGeneralForumTopicParams`](../../../../gramio/interfaces/EditGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editGeneralTopic`](ForumMixin.md#editgeneraltopic)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### editTopic()

> **editTopic**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5167

Edits topic info

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`EditForumTopicParams`](../../../../gramio/interfaces/EditForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`editTopic`](ForumMixin.md#edittopic)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

Defined in: contexts/index.d.ts:5163

Returns custom emoji stickers, which can be used as a forum topic icon by any user

#### Returns

`Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`getTopicIcons`](ForumMixin.md#gettopicicons)

***

### hasFrom()

> **hasFrom**(): this is Require\<GiveawayWinnersContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<GiveawayWinnersContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<GiveawayWinnersContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<GiveawayWinnersContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### hideGeneralTopic()

> **hideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5185

Hides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`HideGeneralForumTopicParams`](../../../../gramio/interfaces/HideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`hideGeneralTopic`](ForumMixin.md#hidegeneraltopic)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<GiveawayWinnersContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<GiveawayWinnersContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGeneralTopic()

> **isGeneralTopic**(): `this is RequireValue<GiveawayWinnersContext<Bot>, "threadId", undefined>`

Defined in: contexts/index.d.ts:5161

Checks whether this topic is actually a 'General' one

#### Returns

`this is RequireValue<GiveawayWinnersContext<Bot>, "threadId", undefined>`

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`isGeneralTopic`](ForumMixin.md#isgeneraltopic)

***

### isGroup()

> **isGroup**(): `this is RequireValue<GiveawayWinnersContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<GiveawayWinnersContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<GiveawayWinnersContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<GiveawayWinnersContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<GiveawayWinnersContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<GiveawayWinnersContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reopenGeneralTopic()

> **reopenGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5177

Reopens General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenGeneralForumTopicParams`](../../../../gramio/interfaces/ReopenGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenGeneralTopic`](ForumMixin.md#reopengeneraltopic)

***

### reopenTopic()

> **reopenTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5175

Reopens topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReopenForumTopicParams`](../../../../gramio/interfaces/ReopenForumTopicParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`reopenTopic`](ForumMixin.md#reopentopic)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unhideGeneralTopic()

> **unhideGeneralTopic**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5187

Unhides General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnhideGeneralForumTopicParams`](../../../../gramio/interfaces/UnhideGeneralForumTopicParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unhideGeneralTopic`](ForumMixin.md#unhidegeneraltopic)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinAllGeneralTopicMessages()

> **unpinAllGeneralTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5183

Clears the list of pinned messages in a General topic

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllGeneralForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllGeneralForumTopicMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllGeneralTopicMessages`](ForumMixin.md#unpinallgeneraltopicmessages)

***

### unpinAllTopicMessages()

> **unpinAllTopicMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5181

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllForumTopicMessagesParams`](../../../../gramio/interfaces/UnpinAllForumTopicMessagesParams.md), `"chat_id"` | `"message_thread_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ForumMixin`](ForumMixin.md).[`unpinAllTopicMessages`](ForumMixin.md#unpinalltopicmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/GroupChatCreatedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GroupChatCreatedContext

# Class: GroupChatCreatedContext\<Bot>

Defined in: contexts/index.d.ts:5905

service message: the group has been created

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`GroupChatCreatedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `GroupChatCreatedContext`<`Bot`>, `GroupChatCreatedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new GroupChatCreatedContext**<`Bot`>(`options`): `GroupChatCreatedContext`<`Bot`>

Defined in: contexts/index.d.ts:5908

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `GroupChatCreatedContextOptions`<`Bot`> |

#### Returns

`GroupChatCreatedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new GroupChatCreatedContext**(...`args`): `GroupChatCreatedContext`

Defined in: contexts/index.d.ts:5905

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`GroupChatCreatedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5907 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `GroupChatCreatedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `GroupChatCreatedContextOptions` |

#### Returns

`GroupChatCreatedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<GroupChatCreatedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<GroupChatCreatedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<GroupChatCreatedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<GroupChatCreatedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<GroupChatCreatedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<GroupChatCreatedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<GroupChatCreatedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<GroupChatCreatedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<GroupChatCreatedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<GroupChatCreatedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<GroupChatCreatedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<GroupChatCreatedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/InaccessibleMessage.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / InaccessibleMessage

# Class: InaccessibleMessage

Defined in: contexts/index.d.ts:1428

This object describes a message that was deleted or is otherwise inaccessible to the bot.

[Documentation](https://core.telegram.org/bots/api/#inaccessiblemessage)

## Constructors

### Constructor

> **new InaccessibleMessage**(`payload`): `InaccessibleMessage`

Defined in: contexts/index.d.ts:1430

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramInaccessibleMessage`](../../../../gramio/interfaces/TelegramInaccessibleMessage.md) |

#### Returns

`InaccessibleMessage`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramInaccessibleMessage`](../../../../gramio/interfaces/TelegramInaccessibleMessage.md) | contexts/index.d.ts:1429 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1432

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:1436

Chat the message belonged to

##### Returns

[`Chat`](Chat.md)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:1438

Always `0`. The field can be used to differentiate regular and inaccessible messages.

##### Returns

`number`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:1434

Unique message identifier inside the chat

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/keyboards/classes/InlineKeyboard.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / InlineKeyboard

# Class: InlineKeyboard

Defined in: keyboards/index.d.ts:401

**InlineKeyboardMarkup** builder

This object represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.

[\[Documentation\]](https://core.telegram.org/bots/api/#inlinekeyboardmarkup)

## Extends

* [`BaseKeyboardConstructor`](BaseKeyboardConstructor.md)<[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)>

## Constructors

### Constructor

> **new InlineKeyboard**(`featureFlags?`): `InlineKeyboard`

Defined in: keyboards/index.d.ts:48

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `featureFlags?` | [`KeyboardFeatureFlags`](../interfaces/KeyboardFeatureFlags.md) |

#### Returns

`InlineKeyboard`

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`constructor`](BaseKeyboardConstructor.md#constructor)

## Properties

| Property | Modifier | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `currentRow` | `protected` | [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)\[] | [`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`currentRow`](BaseKeyboardConstructor.md#currentrow) | keyboards/index.d.ts:46 |
|  `featureFlags` | `protected` | [`KeyboardFeatureFlags`](../interfaces/KeyboardFeatureFlags.md) | [`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`featureFlags`](BaseKeyboardConstructor.md#featureflags) | keyboards/index.d.ts:47 |
|  `rows` | `protected` | [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)\[]\[] | [`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`rows`](BaseKeyboardConstructor.md#rows) | keyboards/index.d.ts:45 |

## Accessors

### keyboard

#### Get Signature

> **get** `protected` **keyboard**(): `T`\[]\[]

Defined in: keyboards/index.d.ts:52

##### Returns

`T`\[]\[]

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`keyboard`](BaseKeyboardConstructor.md#keyboard)

## Methods

### add()

> **add**(...`buttons`): `this`

Defined in: keyboards/index.d.ts:127

Allows you to add multiple buttons in raw format.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`buttons` | [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)\[] |

#### Returns

`this`

#### Example

```ts
const labels = ["some", "buttons"];

new InlineKeyboard()
    .add({ text: "raw button", callback_data: "payload" })
    .add(InlineKeyboard.text("raw button by InlineKeyboard.text", "payload"))
    .add(...labels.map((x) => InlineKeyboard.text(x, `${x}payload`)));
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`add`](BaseKeyboardConstructor.md#add)

***

### addIf()

> **addIf**(`condition`, ...`buttons`): `this`

Defined in: keyboards/index.d.ts:147

Allows you to dynamically substitute buttons depending on something

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `condition` | `boolean` | (`options`) => `boolean` |
| ...`buttons` | [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)\[] |

#### Returns

`this`

#### Example

```ts
const labels = ["some", "buttons"];
const isAdmin = true;

new InlineKeyboard()
    .addIf(1 === 2, { text: "raw button", callback_data: "payload" })
    .addIf(
        isAdmin,
        InlineKeyboard.text("raw button by InlineKeyboard.text", "payload")
    )
    .addIf(
        ({ index, rowIndex }) => rowIndex === index,
        ...labels.map((x) => InlineKeyboard.text(x, `${x}payload`))
    );
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`addIf`](BaseKeyboardConstructor.md#addif)

***

### build()

> **build**(): `TelegramInlineKeyboardMarkupFix`

Defined in: keyboards/index.d.ts:573

Return [TelegramInlineKeyboardMarkup](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) as JSON

#### Returns

`TelegramInlineKeyboardMarkupFix`

***

### columns()

> **columns**(`length?`): `this`

Defined in: keyboards/index.d.ts:75

Allows you to limit the number of columns in the keyboard.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `length?` | `number` |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .columns(1)
    .text("first row", "payload")
    .text("second row", "payload");
    .text("third row", "payload");
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`columns`](BaseKeyboardConstructor.md#columns)

***

### combine()

> **combine**(`keyboard`): `this`

Defined in: keyboards/index.d.ts:567

Allows you to combine keyboards. Only keyboards are combined. You need to call the `.row()` method to line-break after combine.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `keyboard` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)\[]\[] | { `toJSON`: () => [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
			.combine(new InlineKeyboard().text("some", "payload"))
			.row()
			.combine(
				new InlineKeyboard()
					.text("test", "payload")
					.row()
					.text("second row???", "payload"),
			)
```

***

### copy()

> **copy**(`text`, `textToCopy`, `options?`): `this`

Defined in: keyboards/index.d.ts:549

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `textToCopy` | `string` | [`TelegramCopyTextButton`](../../../../gramio/interfaces/TelegramCopyTextButton.md) |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

***

### filter()

> **filter**(`fn?`): `this`

Defined in: keyboards/index.d.ts:99

A handler that helps filter keyboard buttons

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `fn?` | [`ButtonsIterator`](../type-aliases/ButtonsIterator.md)<[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)> |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .filter(({ button }) => button.callback_data !== "hidden")
    .text("button", "pass")
    .text("button", "hidden")
    .text("button", "pass");
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`filter`](BaseKeyboardConstructor.md#filter)

***

### game()

> **game**(`text`, `gameOptions?`, `options?`): `this`

Defined in: keyboards/index.d.ts:542

Description of the game that will be launched when the user presses the button.

**NOTE:** This type of button **must** always be the first button in the first row.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `gameOptions?` | [`TelegramCallbackGame`](../../../../gramio/interfaces/TelegramCallbackGame.md) |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard().game("text", ???);
```

***

### login()

> **login**(`text`, `url`, `options?`): `this`

Defined in: keyboards/index.d.ts:454

An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the [Telegram Login Widget](https://core.telegram.org/widgets/login).

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `url` | `string` | [`TelegramLoginUrl`](../../../../gramio/interfaces/TelegramLoginUrl.md) |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard().login("some text", "https://...");
// or
new InlineKeyboard().login("some text", {
   url: "https://...",
   request_write_access: true,
});
```

***

### matrix()

> **matrix**(`rows`, `columns`, `fn`): `this`

Defined in: keyboards/index.d.ts:167

Allows you to create a button matrix.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rows` | `number` |
| `columns` | `number` |
| `fn` | [`CreateButtonIterator`](../type-aliases/CreateButtonIterator.md)<[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)> |

#### Returns

`this`

#### Example

```ts
import { randomInt } from "node:crypto";

const bomb = [randomInt(0, 9), randomInt(0, 9)] as const;

new InlineKeyboard().matrix(10, 10, ({ rowIndex, index }) =>
   InlineKeyboard.text(
       rowIndex === bomb[0] && index === bomb[1] ? "💣" : "ㅤ",
       "payload"
   )
);
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`matrix`](BaseKeyboardConstructor.md#matrix)

***

### pattern()

> **pattern**(`pattern?`): `this`

Defined in: keyboards/index.d.ts:114

An array with the number of columns per row. Allows you to set a "template"

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `pattern?` | `number`\[] |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .pattern([1, 3, 2])
    .text("1", "payload")
    .text("2", "payload")
    .text("2", "payload")
    .text("2", "payload")
    .text("3", "payload")
    .text("3", "payload");
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`pattern`](BaseKeyboardConstructor.md#pattern)

***

### pay()

> **pay**(`text`, `options?`): `this`

Defined in: keyboards/index.d.ts:468

Send a [Pay button](https://core.telegram.org/bots/api/#payments).

**NOTE:** This type of button **must** always be the first button in the first row and can only be used in invoice messages.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard().pay("5 coins");
```

***

### resetHelpers()

> **resetHelpers**(): `this`

Defined in: keyboards/index.d.ts:168

#### Returns

`this`

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`resetHelpers`](BaseKeyboardConstructor.md#resethelpers)

***

### row()

> **row**(): `this`

Defined in: keyboards/index.d.ts:63

Adds a `line break`. Call this method to make sure that the next added buttons will be on a new row.

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .text("first row", "payload")
    .row()
    .text("second row", "payload");
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`row`](BaseKeyboardConstructor.md#row)

***

### switchToChat()

> **switchToChat**(`text`, `query?`, `options?`): `this`

Defined in: keyboards/index.d.ts:486

Pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field.

By default empty, in which case just the bot's username will be inserted.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `query?` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard().switchToChat("Select chat");
// or
new InlineKeyboard().switchToChat("Select chat", "InlineQuery");
```

***

### switchToChosenChat()

> **switchToChosenChat**(`text`, `query?`, `options?`): `this`

Defined in: keyboards/index.d.ts:510

Pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `query?` | `string` | [`TelegramSwitchInlineQueryChosenChat`](../../../../gramio/interfaces/TelegramSwitchInlineQueryChosenChat.md) |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard().switchToChosenChat("Select chat");
// or
new InlineKeyboard().switchToChosenChat("Select chat", "InlineQuery");
// or
new InlineKeyboard().switchToChosenChat("Select chat", {
    query: "InlineQuery",
    allow_channel_chats: true,
    allow_group_chats: true,
    allow_bot_chats: true,
    allow_user_chats: true,
});
```

***

### switchToCurrentChat()

> **switchToCurrentChat**(`text`, `query?`, `options?`): `this`

Defined in: keyboards/index.d.ts:526

Pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.

This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `query?` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard().switchToChosenChat("Open Inline mod");
// or
new InlineKeyboard().switchToChosenChat("Open Inline mod", "InlineQuery");
```

***

### text()

> **text**(`text`, `payload`, `options?`): `this`

Defined in: keyboards/index.d.ts:413

Text button with data to be sent in a [callback query](https://core.telegram.org/bots/api/#callbackquery) to the bot when button is pressed, 1-64 bytes

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `payload` | `string` | `Record`<`string`, `unknown`> |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard().text("some text", "payload");
// or
new InlineKeyboard().text("some text", {
    json: "payload",
}); // it uses JSON.stringify
```

***

### toJSON()

> **toJSON**(): `TelegramInlineKeyboardMarkupFix`

Defined in: keyboards/index.d.ts:577

Serializing a class into an TelegramInlineKeyboardMarkupFix object (used by JSON.stringify)

#### Returns

`TelegramInlineKeyboardMarkupFix`

***

### url()

> **url**(`text`, `url`, `options?`): `this`

Defined in: keyboards/index.d.ts:425

HTTP or tg:// URL to be opened when the button is pressed. Links `tg://user?id=<user_id>` can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `url` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard().url("GitHub", "https://github.com/gramiojs/gramio");
```

***

### webApp()

> **webApp**(`text`, `url`, `options?`): `this`

Defined in: keyboards/index.d.ts:437

Description of the [Web App](https://core.telegram.org/bots/webapps) that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method [answerWebAppQuery](https://core.telegram.org/bots/api/#answerwebappquery). Available only in private chats between a user and the bot.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `url` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard().webApp("some text", "https://...");
```

***

### wrap()

> **wrap**(`fn?`): `this`

Defined in: keyboards/index.d.ts:87

A custom handler that controls row wrapping.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `fn?` | [`ButtonsIterator`](../type-aliases/ButtonsIterator.md)<[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)> |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .wrap(({ button }) => button.callback_data === "2")
    .text("first row", "1")
    .text("first row", "1");
    .text("second row", "2");
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`wrap`](BaseKeyboardConstructor.md#wrap)

***

### copy()

> `static` **copy**(`text`, `textToCopy`, `options?`): [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

Defined in: keyboards/index.d.ts:550

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `textToCopy` | `string` | [`TelegramCopyTextButton`](../../../../gramio/interfaces/TelegramCopyTextButton.md) |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

***

### game()

> `static` **game**(`text`, `gameOptions?`, `options?`): [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

Defined in: keyboards/index.d.ts:548

Description of the game that will be launched when the user presses the button.

**NOTE:** This type of button **must** always be the first button in the first row.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `gameOptions?` | [`TelegramCallbackGame`](../../../../gramio/interfaces/TelegramCallbackGame.md) |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

***

### login()

> `static` **login**(`text`, `url`, `options?`): [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

Defined in: keyboards/index.d.ts:458

An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the [Telegram Login Widget](https://core.telegram.org/widgets/login).

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `url` | `string` | [`TelegramLoginUrl`](../../../../gramio/interfaces/TelegramLoginUrl.md) |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

***

### pay()

> `static` **pay**(`text`, `options?`): [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

Defined in: keyboards/index.d.ts:474

Send a [Pay button](https://core.telegram.org/bots/api/#payments).

**NOTE:** This type of button **must** always be the first button in the first row and can only be used in invoice messages.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

***

### switchToChat()

> `static` **switchToChat**(`text`, `query?`, `options?`): [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

Defined in: keyboards/index.d.ts:492

If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field.

By default empty, in which case just the bot's username will be inserted.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `query?` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

***

### switchToChosenChat()

> `static` **switchToChosenChat**(`text`, `query?`, `options?`): [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

Defined in: keyboards/index.d.ts:514

Pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `query?` | `string` | [`TelegramSwitchInlineQueryChosenChat`](../../../../gramio/interfaces/TelegramSwitchInlineQueryChosenChat.md) |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

***

### switchToCurrentChat()

> `static` **switchToCurrentChat**(`text`, `query?`, `options?`): [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

Defined in: keyboards/index.d.ts:532

Pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.

This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `query?` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

***

### text()

> `static` **text**(`text`, `payload`, `options?`): [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

Defined in: keyboards/index.d.ts:417

Text button with data to be sent in a [callback query](https://core.telegram.org/bots/api/#callbackquery) to the bot when button is pressed, 1-64 bytes

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `payload` | `string` | `Record`<`string`, `unknown`> |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

***

### url()

> `static` **url**(`text`, `url`, `options?`): [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

Defined in: keyboards/index.d.ts:429

HTTP or tg:// URL to be opened when the button is pressed. Links `tg://user?id=<user_id>` can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `url` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

***

### webApp()

> `static` **webApp**(`text`, `url`, `options?`): [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

Defined in: keyboards/index.d.ts:441

Description of the [Web App](https://core.telegram.org/bots/webapps) that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method [answerWebAppQuery](https://core.telegram.org/bots/api/#answerwebappquery). Available only in private chats between a user and the bot.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `url` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/InlineKeyboardButton.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / InlineKeyboardButton

# Class: InlineKeyboardButton

Defined in: contexts/index.d.ts:1985

This object represents one button of an inline keyboard. You must use exactly one of the optional fields.

## Constructors

### Constructor

> **new InlineKeyboardButton**(`payload`): `InlineKeyboardButton`

Defined in: contexts/index.d.ts:1987

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md) |

#### Returns

`InlineKeyboardButton`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramInlineKeyboardButton`](../../../../gramio/interfaces/TelegramInlineKeyboardButton.md) | contexts/index.d.ts:1986 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1989

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### callbackData

#### Get Signature

> **get** **callbackData**(): `string`

Defined in: contexts/index.d.ts:2003

Data to be sent in a callback query to the bot when button is pressed,
1-64 bytes

##### Returns

`string`

***

### callbackGame

#### Get Signature

> **get** **callbackGame**(): [`CallbackGame`](CallbackGame.md)

Defined in: contexts/index.d.ts:2033

Description of the game that will be launched when the user presses the
button.

**NOTE**: This type of button **must** always be the first button in the
first row.

##### Returns

[`CallbackGame`](CallbackGame.md)

***

### loginUrl

#### Get Signature

> **get** **loginUrl**(): [`LoginUrl`](LoginUrl.md)

Defined in: contexts/index.d.ts:1998

An HTTP URL used to automatically authorize the user.
Can be used as a replacement for the Telegram Login Widget.

##### Returns

[`LoginUrl`](LoginUrl.md)

***

### pay

#### Get Signature

> **get** **pay**(): `boolean`

Defined in: contexts/index.d.ts:2039

Specify `true`, to send a Pay button.

**NOTE**: This type of button **must** always be the first button in the first row.

##### Returns

`boolean`

***

### switchInlineQuery

#### Get Signature

> **get** **switchInlineQuery**(): `string`

Defined in: contexts/index.d.ts:2016

If set, pressing the button will prompt the user to select one of their
chats, open that chat and insert the bot's username and the specified
inline query in the input field. Can be empty, in which case just the
bot's username will be inserted.

**Note**: This offers an easy way for users to start using your bot in
inline mode when they are currently in a private chat with it. Especially
useful when combined with `switch_pm…` actions – in this case the user will
be automatically returned to the chat they switched from, skipping the
chat selection screen.

##### Returns

`string`

***

### switchInlineQueryCurrentChat

#### Get Signature

> **get** **switchInlineQueryCurrentChat**(): `string`

Defined in: contexts/index.d.ts:2025

If set, pressing the button will insert the bot's username and the
specified inline query in the current chat's input field. Can be empty, in
which case only the bot's username will be inserted.

This offers a quick way for the user to open your bot in inline mode in
the same chat – good for selecting something from multiple options.

##### Returns

`string`

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:1991

Label text on the button

##### Returns

`string`

***

### url

#### Get Signature

> **get** **url**(): `string`

Defined in: contexts/index.d.ts:1993

HTTP or tg:// url to be opened when button is pressed

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/InlineKeyboardMarkup.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / InlineKeyboardMarkup

# Class: InlineKeyboardMarkup

Defined in: contexts/index.d.ts:2043

This object represents an inline keyboard that appears right next to the message it belongs to.

## Constructors

### Constructor

> **new InlineKeyboardMarkup**(`payload`): `InlineKeyboardMarkup`

Defined in: contexts/index.d.ts:2045

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) |

#### Returns

`InlineKeyboardMarkup`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | contexts/index.d.ts:2044 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2047

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### inlineKeyboard

#### Get Signature

> **get** **inlineKeyboard**(): [`InlineKeyboardButton`](InlineKeyboardButton.md)\[]\[]

Defined in: contexts/index.d.ts:2049

Array of button rows

##### Returns

[`InlineKeyboardButton`](InlineKeyboardButton.md)\[]\[]

---

---
url: 'https://gramio.dev/api/contexts/classes/InlineQuery.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / InlineQuery

# Class: InlineQuery

Defined in: contexts/index.d.ts:4072

This object represents an incoming inline query.
When the user sends an empty query, your bot could return some default or
trending results.

## Extended by

* [`InlineQueryContext`](InlineQueryContext.md)

## Constructors

### Constructor

> **new InlineQuery**(`payload`): `InlineQuery`

Defined in: contexts/index.d.ts:4074

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramInlineQuery`](../../../../gramio/interfaces/TelegramInlineQuery.md) |

#### Returns

`InlineQuery`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramInlineQuery`](../../../../gramio/interfaces/TelegramInlineQuery.md) | contexts/index.d.ts:4073 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4076

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4080

Sender

##### Returns

[`User`](User.md)

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:4078

Unique identifier for this query

##### Returns

`string`

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:4082

Sender location, only for bots that request user location

##### Returns

[`Location`](Location.md)

***

### offset

#### Get Signature

> **get** **offset**(): `string`

Defined in: contexts/index.d.ts:4086

Offset of the results to be returned, can be controlled by the bot

##### Returns

`string`

***

### query

#### Get Signature

> **get** **query**(): `string`

Defined in: contexts/index.d.ts:4084

Text of the query (up to 256 characters)

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/InlineQueryContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / InlineQueryContext

# Class: InlineQueryContext\<Bot>

Defined in: contexts/index.d.ts:5924

This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.

[Documentation](https://core.telegram.org/bots/api/#inlinequery)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`InlineQueryContext`<`Bot`>>.[`InlineQuery`](InlineQuery.md).[`CloneMixin`](CloneMixin.md)<`Bot`, `InlineQueryContext`<`Bot`>, `InlineQueryContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new InlineQueryContext**<`Bot`>(`options`): `InlineQueryContext`<`Bot`>

Defined in: contexts/index.d.ts:5927

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `InlineQueryContextOptions`<`Bot`> |

#### Returns

`InlineQueryContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new InlineQueryContext**(...`args`): `InlineQueryContext`

Defined in: contexts/index.d.ts:5924

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`InlineQueryContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramInlineQuery`](../../../../gramio/interfaces/TelegramInlineQuery.md) | The raw data that is used for this Context | [`InlineQuery`](InlineQuery.md).[`payload`](InlineQuery.md#payload) | contexts/index.d.ts:5926 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4080

Sender

##### Returns

[`User`](User.md)

#### Inherited from

[`InlineQuery`](InlineQuery.md).[`from`](InlineQuery.md#from)

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:4078

Unique identifier for this query

##### Returns

`string`

#### Inherited from

[`InlineQuery`](InlineQuery.md).[`id`](InlineQuery.md#id)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:4082

Sender location, only for bots that request user location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`InlineQuery`](InlineQuery.md).[`location`](InlineQuery.md#location)

***

### offset

#### Get Signature

> **get** **offset**(): `string`

Defined in: contexts/index.d.ts:4086

Offset of the results to be returned, can be controlled by the bot

##### Returns

`string`

#### Inherited from

[`InlineQuery`](InlineQuery.md).[`offset`](InlineQuery.md#offset)

***

### query

#### Get Signature

> **get** **query**(): `string`

Defined in: contexts/index.d.ts:4084

Text of the query (up to 256 characters)

##### Returns

`string`

#### Inherited from

[`InlineQuery`](InlineQuery.md).[`query`](InlineQuery.md#query)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:5929

Sender's ID

##### Returns

`number`

## Methods

### answer()

> **answer**(`results`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5935

Answers to inline query. An alias for `answerInlineQuery`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `results` | [`TelegramInlineQueryResult`](../../../../gramio/type-aliases/TelegramInlineQueryResult.md)\[] |
| `params?` | `Partial`<[`AnswerInlineQueryParams`](../../../../gramio/interfaces/AnswerInlineQueryParams.md)> |

#### Returns

`Promise`<`true`>

***

### answerInlineQuery()

> **answerInlineQuery**(`results`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5933

Answers to inline query

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `results` | [`TelegramInlineQueryResult`](../../../../gramio/type-aliases/TelegramInlineQueryResult.md)\[] |
| `params?` | `Partial`<[`AnswerInlineQueryParams`](../../../../gramio/interfaces/AnswerInlineQueryParams.md)> |

#### Returns

`Promise`<`true`>

***

### clone()

> **clone**(`options?`): `InlineQueryContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `InlineQueryContextOptions` |

#### Returns

`InlineQueryContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### hasLocation()

> **hasLocation**(): `this is Require<InlineQueryContext<Bot>, "location">`

Defined in: contexts/index.d.ts:5931

Checks if query has `location` property

#### Returns

`this is Require<InlineQueryContext<Bot>, "location">`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

---

---
url: 'https://gramio.dev/api/keyboards/classes/InlineQueryResult.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / InlineQueryResult

# Class: InlineQueryResult

Defined in: keyboards/index.d.ts:775

Result of InlineQuery builder.

## Example

```ts
bot.api.answerInlineQuery({
	inline_query_id: context.id,
	results: [
		InlineQueryResult.article(
			"id-1",
			"some article",
			InputMessageContent.text("my article"),
		),
	],
});
```

[Documentation](https://core.telegram.org/bots/api#inlinequeryresult)

## Constructors

### Constructor

> **new InlineQueryResult**(): `InlineQueryResult`

#### Returns

`InlineQueryResult`

## Properties

| Property | Modifier | Type | Description | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `cached` | `static` | *typeof* `InlineQueryResultCached` | Cached result of InlineQuery builder. | keyboards/index.d.ts:777 |

## Methods

### article()

> `static` **article**(`id`, `title`, `inputMessageContent`, `options?`): [`TelegramInlineQueryResultArticle`](../../../../gramio/interfaces/TelegramInlineQueryResultArticle.md)

Defined in: keyboards/index.d.ts:783

Represents a link to an article or web page.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultarticle)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `title` | `string` |
| `inputMessageContent` | [`TelegramInputMessageContent`](../../../../gramio/type-aliases/TelegramInputMessageContent.md) |
| `options?` | `Omit`<[`TelegramInlineQueryResultArticle`](../../../../gramio/interfaces/TelegramInlineQueryResultArticle.md), `"type"` | `"title"` | `"id"` | `"input_message_content"`> |

#### Returns

[`TelegramInlineQueryResultArticle`](../../../../gramio/interfaces/TelegramInlineQueryResultArticle.md)

***

### audio()

> `static` **audio**(`id`, `title`, `audioUrl`, `options?`): [`TelegramInlineQueryResultAudio`](../../../../gramio/interfaces/TelegramInlineQueryResultAudio.md)

Defined in: keyboards/index.d.ts:789

Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the audio.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultaudio)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `title` | `string` |
| `audioUrl` | `string` |
| `options?` | `Omit`<[`TelegramInlineQueryResultAudio`](../../../../gramio/interfaces/TelegramInlineQueryResultAudio.md), `"type"` | `"title"` | `"id"` | `"audio_url"`> |

#### Returns

[`TelegramInlineQueryResultAudio`](../../../../gramio/interfaces/TelegramInlineQueryResultAudio.md)

***

### contact()

> `static` **contact**(`id`, `phoneNumber`, `firstName`, `options?`): [`TelegramInlineQueryResultContact`](../../../../gramio/interfaces/TelegramInlineQueryResultContact.md)

Defined in: keyboards/index.d.ts:795

Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the contact.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultcontact)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `phoneNumber` | `string` |
| `firstName` | `string` |
| `options?` | `Omit`<[`TelegramInlineQueryResultContact`](../../../../gramio/interfaces/TelegramInlineQueryResultContact.md), `"type"` | `"phone_number"` | `"id"` | `"first_name"`> |

#### Returns

[`TelegramInlineQueryResultContact`](../../../../gramio/interfaces/TelegramInlineQueryResultContact.md)

***

### documentPdf()

> `static` **documentPdf**(`id`, `title`, `url`, `options?`): [`TelegramInlineQueryResultDocument`](../../../../gramio/interfaces/TelegramInlineQueryResultDocument.md)

Defined in: keyboards/index.d.ts:807

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the file. Currently, only **.PDF** and **.ZIP** files can be sent using this method.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultdocument)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `title` | `string` |
| `url` | `string` |
| `options?` | `Omit`<[`TelegramInlineQueryResultDocument`](../../../../gramio/interfaces/TelegramInlineQueryResultDocument.md), `"type"` | `"mime_type"` | `"id"` | `"title"` | `"document_url"`> |

#### Returns

[`TelegramInlineQueryResultDocument`](../../../../gramio/interfaces/TelegramInlineQueryResultDocument.md)

***

### documentZip()

> `static` **documentZip**(`id`, `title`, `url`, `options?`): [`TelegramInlineQueryResultDocument`](../../../../gramio/interfaces/TelegramInlineQueryResultDocument.md)

Defined in: keyboards/index.d.ts:813

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the file. Currently, only **.PDF** and **.ZIP** files can be sent using this method.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultdocument)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `title` | `string` |
| `url` | `string` |
| `options?` | `Omit`<[`TelegramInlineQueryResultDocument`](../../../../gramio/interfaces/TelegramInlineQueryResultDocument.md), `"type"` | `"mime_type"` | `"id"` | `"title"` | `"document_url"`> |

#### Returns

[`TelegramInlineQueryResultDocument`](../../../../gramio/interfaces/TelegramInlineQueryResultDocument.md)

***

### game()

> `static` **game**(`id`, `gameShortName`, `options?`): [`TelegramInlineQueryResultGame`](../../../../gramio/interfaces/TelegramInlineQueryResultGame.md)

Defined in: keyboards/index.d.ts:801

Represents a [Game](https://core.telegram.org/bots/api/#games).

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultgame)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `gameShortName` | `string` |
| `options?` | `Omit`<[`TelegramInlineQueryResultGame`](../../../../gramio/interfaces/TelegramInlineQueryResultGame.md), `"type"` | `"game_short_name"` | `"id"`> |

#### Returns

[`TelegramInlineQueryResultGame`](../../../../gramio/interfaces/TelegramInlineQueryResultGame.md)

***

### gif()

> `static` **gif**(`id`, `gifUrl`, `thumbnailUrl`, `options?`): [`TelegramInlineQueryResultGif`](../../../../gramio/interfaces/TelegramInlineQueryResultGif.md)

Defined in: keyboards/index.d.ts:819

Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the animation.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultgif)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `gifUrl` | `string` |
| `thumbnailUrl` | `string` |
| `options?` | `Omit`<[`TelegramInlineQueryResultGif`](../../../../gramio/interfaces/TelegramInlineQueryResultGif.md), `"type"` | `"gif_url"` | `"id"` | `"thumbnail_url"`> |

#### Returns

[`TelegramInlineQueryResultGif`](../../../../gramio/interfaces/TelegramInlineQueryResultGif.md)

***

### location()

> `static` **location**(`id`, `latitude`, `longitude`, `title`, `options?`): [`TelegramInlineQueryResultLocation`](../../../../gramio/interfaces/TelegramInlineQueryResultLocation.md)

Defined in: keyboards/index.d.ts:825

Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the location.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultlocation)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `latitude` | `number` |
| `longitude` | `number` |
| `title` | `string` |
| `options?` | `Omit`<[`TelegramInlineQueryResultLocation`](../../../../gramio/interfaces/TelegramInlineQueryResultLocation.md), `"type"` | `"latitude"` | `"id"` | `"longitude"` | `"title"`> |

#### Returns

[`TelegramInlineQueryResultLocation`](../../../../gramio/interfaces/TelegramInlineQueryResultLocation.md)

***

### mpeg4Gif()

> `static` **mpeg4Gif**(`id`, `mpeg4Url`, `thumbnailUrl`, `options?`): [`TelegramInlineQueryResultMpeg4Gif`](../../../../gramio/interfaces/TelegramInlineQueryResultMpeg4Gif.md)

Defined in: keyboards/index.d.ts:831

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the animation.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultmpeg4gif)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `mpeg4Url` | `string` |
| `thumbnailUrl` | `string` |
| `options?` | `Omit`<[`TelegramInlineQueryResultMpeg4Gif`](../../../../gramio/interfaces/TelegramInlineQueryResultMpeg4Gif.md), `"type"` | `"mpeg4_url"` | `"id"` | `"thumbnail_url"`> |

#### Returns

[`TelegramInlineQueryResultMpeg4Gif`](../../../../gramio/interfaces/TelegramInlineQueryResultMpeg4Gif.md)

***

### photo()

> `static` **photo**(`id`, `photoUrl`, `thumbnailUrl`, `options?`): [`TelegramInlineQueryResultPhoto`](../../../../gramio/interfaces/TelegramInlineQueryResultPhoto.md)

Defined in: keyboards/index.d.ts:837

Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the photo.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultphoto)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `photoUrl` | `string` |
| `thumbnailUrl` | `string` |
| `options?` | `Omit`<[`TelegramInlineQueryResultPhoto`](../../../../gramio/interfaces/TelegramInlineQueryResultPhoto.md), `"type"` | `"photo_url"` | `"id"` | `"thumbnail_url"`> |

#### Returns

[`TelegramInlineQueryResultPhoto`](../../../../gramio/interfaces/TelegramInlineQueryResultPhoto.md)

***

### venue()

> `static` **venue**(`id`, `options`): [`TelegramInlineQueryResultVenue`](../../../../gramio/interfaces/TelegramInlineQueryResultVenue.md)

Defined in: keyboards/index.d.ts:843

Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the venue.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultvenue)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `options` | `Omit`<[`TelegramInlineQueryResultVenue`](../../../../gramio/interfaces/TelegramInlineQueryResultVenue.md), `"type"` | `"id"`> |

#### Returns

[`TelegramInlineQueryResultVenue`](../../../../gramio/interfaces/TelegramInlineQueryResultVenue.md)

***

### videoHtml()

> `static` **videoHtml**(`id`, `title`, `videoUrl`, `thumbnailUrl`, `options?`): [`TelegramInlineQueryResultVideo`](../../../../gramio/interfaces/TelegramInlineQueryResultVideo.md)

Defined in: keyboards/index.d.ts:851

Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the video.

If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you **must** replace its content using *input\_message\_content*.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultvideo)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `title` | `string` |
| `videoUrl` | `string` |
| `thumbnailUrl` | `string` |
| `options?` | `Omit`<[`TelegramInlineQueryResultVideo`](../../../../gramio/interfaces/TelegramInlineQueryResultVideo.md), `"type"` | `"video_url"` | `"id"` | `"thumbnail_url"` | `"mime_type"` | `"title"`> |

#### Returns

[`TelegramInlineQueryResultVideo`](../../../../gramio/interfaces/TelegramInlineQueryResultVideo.md)

***

### videoMp4()

> `static` **videoMp4**(`id`, `title`, `videoUrl`, `thumbnailUrl`, `options?`): [`TelegramInlineQueryResultVideo`](../../../../gramio/interfaces/TelegramInlineQueryResultVideo.md)

Defined in: keyboards/index.d.ts:859

Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the video.

If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you **must** replace its content using *input\_message\_content*.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultvideo)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `title` | `string` |
| `videoUrl` | `string` |
| `thumbnailUrl` | `string` |
| `options?` | `Omit`<[`TelegramInlineQueryResultVideo`](../../../../gramio/interfaces/TelegramInlineQueryResultVideo.md), `"type"` | `"video_url"` | `"id"` | `"thumbnail_url"` | `"mime_type"` | `"title"`> |

#### Returns

[`TelegramInlineQueryResultVideo`](../../../../gramio/interfaces/TelegramInlineQueryResultVideo.md)

***

### voice()

> `static` **voice**(`id`, `title`, `url`, `options?`): [`TelegramInlineQueryResultVoice`](../../../../gramio/interfaces/TelegramInlineQueryResultVoice.md)

Defined in: keyboards/index.d.ts:865

Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the the voice message.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultvoice)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |
| `title` | `string` |
| `url` | `string` |
| `options?` | `Omit`<[`TelegramInlineQueryResultVoice`](../../../../gramio/interfaces/TelegramInlineQueryResultVoice.md), `"type"` | `"voice_url"` | `"id"` | `"title"`> |

#### Returns

[`TelegramInlineQueryResultVoice`](../../../../gramio/interfaces/TelegramInlineQueryResultVoice.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/InlineQueryResultLocation.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / InlineQueryResultLocation

# Class: InlineQueryResultLocation

Defined in: contexts/index.d.ts:4004

Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the location.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultlocation)

## Constructors

### Constructor

> **new InlineQueryResultLocation**(`payload`): `InlineQueryResultLocation`

Defined in: contexts/index.d.ts:4006

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramInlineQueryResultLocation`](../../../../gramio/interfaces/TelegramInlineQueryResultLocation.md) |

#### Returns

`InlineQueryResultLocation`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramInlineQueryResultLocation`](../../../../gramio/interfaces/TelegramInlineQueryResultLocation.md) | contexts/index.d.ts:4005 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4008

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### heading

#### Get Signature

> **get** **heading**(): `number`

Defined in: contexts/index.d.ts:4040

*Optional*. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

##### Returns

`number`

***

### horizontalAccuracy

#### Get Signature

> **get** **horizontalAccuracy**(): `number`

Defined in: contexts/index.d.ts:4032

*Optional*. The radius of uncertainty for the location, measured in meters; 0-1500

##### Returns

`number`

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:4016

Unique identifier for this result, 1-64 Bytes

##### Returns

`string`

***

### inputMessageContent

#### Get Signature

> **get** **inputMessageContent**(): [`TelegramInputMessageContent`](../../../../gramio/type-aliases/TelegramInputMessageContent.md)

Defined in: contexts/index.d.ts:4052

*Optional*. Content of the message to be sent instead of the location

##### Returns

[`TelegramInputMessageContent`](../../../../gramio/type-aliases/TelegramInputMessageContent.md)

***

### latitude

#### Get Signature

> **get** **latitude**(): `number`

Defined in: contexts/index.d.ts:4020

Location latitude in degrees

##### Returns

`number`

***

### livePeriod

#### Get Signature

> **get** **livePeriod**(): `number`

Defined in: contexts/index.d.ts:4036

*Optional*. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.

##### Returns

`number`

***

### longitude

#### Get Signature

> **get** **longitude**(): `number`

Defined in: contexts/index.d.ts:4024

Location longitude in degrees

##### Returns

`number`

***

### proximityAlertRadius

#### Get Signature

> **get** **proximityAlertRadius**(): `number`

Defined in: contexts/index.d.ts:4044

*Optional*. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

##### Returns

`number`

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:4048

*Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

***

### thumbnailHeight

#### Get Signature

> **get** **thumbnailHeight**(): `number`

Defined in: contexts/index.d.ts:4064

*Optional*. Thumbnail height

##### Returns

`number`

***

### thumbnailUrl

#### Get Signature

> **get** **thumbnailUrl**(): `string`

Defined in: contexts/index.d.ts:4056

*Optional*. Url of the thumbnail for the result

##### Returns

`string`

***

### thumbnailWidth

#### Get Signature

> **get** **thumbnailWidth**(): `number`

Defined in: contexts/index.d.ts:4060

*Optional*. Thumbnail width

##### Returns

`number`

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:4028

Location title

##### Returns

`string`

***

### type

#### Get Signature

> **get** **type**(): `"location"`

Defined in: contexts/index.d.ts:4012

Type of the result, must be *location*

##### Returns

`"location"`

---

---
url: 'https://gramio.dev/api/contexts/classes/InputChecklist.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / InputChecklist

# Class: InputChecklist

Defined in: contexts/index.d.ts:4123

Describes a checklist to create.

[Documentation](https://core.telegram.org/bots/api/#inputchecklist)

## Constructors

### Constructor

> **new InputChecklist**(`payload`): `InputChecklist`

Defined in: contexts/index.d.ts:4125

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |

#### Returns

`InputChecklist`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) | contexts/index.d.ts:4124 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4126

##### Returns

`string`

***

### othersCanAddTasks

#### Get Signature

> **get** **othersCanAddTasks**(): `boolean`

Defined in: contexts/index.d.ts:4148

*Optional*. Pass *True* if other users can add tasks to the checklist

##### Returns

`boolean`

***

### othersCanMarkTasksAsDone

#### Get Signature

> **get** **othersCanMarkTasksAsDone**(): `boolean`

Defined in: contexts/index.d.ts:4152

*Optional*. Pass *True* if other users can mark tasks as done or not done in the checklist

##### Returns

`boolean`

***

### parseMode

#### Get Signature

> **get** **parseMode**(): `"HTML"` | `"MarkdownV2"` | `"Markdown"`

Defined in: contexts/index.d.ts:4136

Optional. Mode for parsing entities in the title. See [formatting options](https://core.telegram.org/bots/api/#formatting-options) for more details.

##### Returns

`"HTML"` | `"MarkdownV2"` | `"Markdown"`

***

### tasks

#### Get Signature

> **get** **tasks**(): [`InputChecklistTask`](InputChecklistTask.md)\[]

Defined in: contexts/index.d.ts:4144

List of 1-30 tasks in the checklist

##### Returns

[`InputChecklistTask`](InputChecklistTask.md)\[]

***

### title

#### Get Signature

> **get** **title**(): `string` | { `toString`: `string`; }

Defined in: contexts/index.d.ts:4130

Title of the checklist; 1-255 characters after entities parsing

##### Returns

`string` | { `toString`: `string`; }

***

### titleEntities

#### Get Signature

> **get** **titleEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:4140

*Optional*. List of special entities that appear in the title, which can be specified instead of parse\_mode. Currently, only *bold*, *italic*, *underline*, *strikethrough*, *spoiler*, and *custom\_emoji* entities are allowed.

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

---

---
url: 'https://gramio.dev/api/contexts/classes/InputChecklistTask.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / InputChecklistTask

# Class: InputChecklistTask

Defined in: contexts/index.d.ts:4094

Describes a task to add to a checklist.

[Documentation](https://core.telegram.org/bots/api/#inputchecklisttask)

## Constructors

### Constructor

> **new InputChecklistTask**(`payload`): `InputChecklistTask`

Defined in: contexts/index.d.ts:4096

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramInputChecklistTask`](../../../../gramio/interfaces/TelegramInputChecklistTask.md) |

#### Returns

`InputChecklistTask`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramInputChecklistTask`](../../../../gramio/interfaces/TelegramInputChecklistTask.md) | contexts/index.d.ts:4095 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4097

##### Returns

`string`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4101

Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist

##### Returns

`number`

***

### parseMode

#### Get Signature

> **get** **parseMode**(): `"HTML"` | `"MarkdownV2"` | `"Markdown"`

Defined in: contexts/index.d.ts:4111

Optional. Mode for parsing entities in the text. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details.

##### Returns

`"HTML"` | `"MarkdownV2"` | `"Markdown"`

***

### text

#### Get Signature

> **get** **text**(): `string` | { `toString`: `string`; }

Defined in: contexts/index.d.ts:4105

Text of the task; 1-100 characters after entities parsing

##### Returns

`string` | { `toString`: `string`; }

***

### textEntities

#### Get Signature

> **get** **textEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:4115

*Optional*. List of special entities that appear in the text, which can be specified instead of parse\_mode. Currently, only *bold*, *italic*, *underline*, *strikethrough*, *spoiler*, and *custom\_emoji* entities are allowed.

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

---

---
url: 'https://gramio.dev/api/contexts/classes/InputLocationMessageContent.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / InputLocationMessageContent

# Class: InputLocationMessageContent

Defined in: contexts/index.d.ts:4160

Represents the [content](https://core.telegram.org/bots/api/#inputmessagecontent) of a location message to be sent as the result of an inline query.

[Documentation](https://core.telegram.org/bots/api/#inputlocationmessagecontent)

## Constructors

### Constructor

> **new InputLocationMessageContent**(`payload`): `InputLocationMessageContent`

Defined in: contexts/index.d.ts:4162

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramInputLocationMessageContent`](../../../../gramio/interfaces/TelegramInputLocationMessageContent.md) |

#### Returns

`InputLocationMessageContent`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramInputLocationMessageContent`](../../../../gramio/interfaces/TelegramInputLocationMessageContent.md) | contexts/index.d.ts:4161 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4164

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### heading

#### Get Signature

> **get** **heading**(): `number`

Defined in: contexts/index.d.ts:4184

*Optional*. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

##### Returns

`number`

***

### horizontalAccuracy

#### Get Signature

> **get** **horizontalAccuracy**(): `number`

Defined in: contexts/index.d.ts:4176

*Optional*. The radius of uncertainty for the location, measured in meters; 0-1500

##### Returns

`number`

***

### latitude

#### Get Signature

> **get** **latitude**(): `number`

Defined in: contexts/index.d.ts:4168

Latitude of the location in degrees

##### Returns

`number`

***

### livePeriod

#### Get Signature

> **get** **livePeriod**(): `number`

Defined in: contexts/index.d.ts:4180

*Optional*. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.

##### Returns

`number`

***

### longitude

#### Get Signature

> **get** **longitude**(): `number`

Defined in: contexts/index.d.ts:4172

Longitude of the location in degrees

##### Returns

`number`

***

### proximityAlertRadius

#### Get Signature

> **get** **proximityAlertRadius**(): `number`

Defined in: contexts/index.d.ts:4188

*Optional*. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/keyboards/classes/InputMessageContent.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / InputMessageContent

# Class: InputMessageContent

Defined in: keyboards/index.d.ts:671

This object represents the content of a message to be sent as a result of an inline query.

## Example

```typescript
bot.api.answerInlineQuery({
	inline_query_id: context.id,
	results: [
		InlineQueryResult.article(
			"id-1",
			"some article",
			InputMessageContent.text("my article"),
		),
	],
});
```

[Documentation](https://core.telegram.org/bots/api/#inputmessagecontent)

## Constructors

### Constructor

> **new InputMessageContent**(): `InputMessageContent`

#### Returns

`InputMessageContent`

## Methods

### contact()

> `static` **contact**(`phoneNumber`, `firstName`, `options?`): [`TelegramInputContactMessageContent`](../../../../gramio/interfaces/TelegramInputContactMessageContent.md)

Defined in: keyboards/index.d.ts:695

Represents the [content](https://core.telegram.org/bots/api/#inputmessagecontent) of a contact message to be sent as the result of an inline query.

[Documentation](https://core.telegram.org/bots/api/#inputcontactmessagecontent)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `phoneNumber` | `string` |
| `firstName` | `string` |
| `options?` | `Omit`<[`TelegramInputContactMessageContent`](../../../../gramio/interfaces/TelegramInputContactMessageContent.md), `"phone_number"` | `"first_name"`> |

#### Returns

[`TelegramInputContactMessageContent`](../../../../gramio/interfaces/TelegramInputContactMessageContent.md)

***

### invoice()

> `static` **invoice**(`options`): [`TelegramInputInvoiceMessageContent`](../../../../gramio/interfaces/TelegramInputInvoiceMessageContent.md)

Defined in: keyboards/index.d.ts:701

Represents the [content](https://core.telegram.org/bots/api/#inputmessagecontent) of an invoice message to be sent as the result of an inline query.

[Documentation](https://core.telegram.org/bots/api/#inputinvoicemessagecontent)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | [`TelegramInputInvoiceMessageContent`](../../../../gramio/interfaces/TelegramInputInvoiceMessageContent.md) |

#### Returns

[`TelegramInputInvoiceMessageContent`](../../../../gramio/interfaces/TelegramInputInvoiceMessageContent.md)

***

### location()

> `static` **location**(`latitude`, `longitude`, `options?`): [`TelegramInputLocationMessageContent`](../../../../gramio/interfaces/TelegramInputLocationMessageContent.md)

Defined in: keyboards/index.d.ts:683

Represents the [content](https://core.telegram.org/bots/api/#inputmessagecontent) of a location message to be sent as the result of an inline query.

[Documentation](https://core.telegram.org/bots/api/#inputlocationmessagecontent)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `options?` | `Omit`<[`TelegramInputLocationMessageContent`](../../../../gramio/interfaces/TelegramInputLocationMessageContent.md), `"latitude"` | `"longitude"`> |

#### Returns

[`TelegramInputLocationMessageContent`](../../../../gramio/interfaces/TelegramInputLocationMessageContent.md)

***

### text()

> `static` **text**(`text`, `options?`): [`TelegramInputTextMessageContent`](../../../../gramio/interfaces/TelegramInputTextMessageContent.md)

Defined in: keyboards/index.d.ts:677

Represents the [content](https://core.telegram.org/bots/api/#inputmessagecontent) of a text message to be sent as the result of an inline query.

[Documentation](https://core.telegram.org/bots/api/#inputtextmessagecontent)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `options?` | `Omit`<[`TelegramInputTextMessageContent`](../../../../gramio/interfaces/TelegramInputTextMessageContent.md), `"message_text"`> |

#### Returns

[`TelegramInputTextMessageContent`](../../../../gramio/interfaces/TelegramInputTextMessageContent.md)

***

### venue()

> `static` **venue**(`options`): [`TelegramInputLocationMessageContent`](../../../../gramio/interfaces/TelegramInputLocationMessageContent.md)

Defined in: keyboards/index.d.ts:689

Represents the [content](https://core.telegram.org/bots/api/#inputmessagecontent) of a venue message to be sent as the result of an inline query.

[Documentation](https://core.telegram.org/bots/api/#inputvenuemessagecontent)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | [`TelegramInputVenueMessageContent`](../../../../gramio/interfaces/TelegramInputVenueMessageContent.md) |

#### Returns

[`TelegramInputLocationMessageContent`](../../../../gramio/interfaces/TelegramInputLocationMessageContent.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/InputPollOption.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / InputPollOption

# Class: InputPollOption

Defined in: contexts/index.d.ts:4196

This object contains information about one answer option in a poll to send.

[Documentation](https://core.telegram.org/bots/api/#inputpolloption)

## Constructors

### Constructor

> **new InputPollOption**(`payload`): `InputPollOption`

Defined in: contexts/index.d.ts:4198

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramInputPollOption`](../../../../gramio/interfaces/TelegramInputPollOption.md) |

#### Returns

`InputPollOption`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramInputPollOption`](../../../../gramio/interfaces/TelegramInputPollOption.md) | contexts/index.d.ts:4197 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4200

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### text

#### Get Signature

> **get** **text**(): `string` | { `toString`: `string`; }

Defined in: contexts/index.d.ts:4204

Option text, 1-100 characters

##### Returns

`string` | { `toString`: `string`; }

***

### textEntities

#### Get Signature

> **get** **textEntities**(): [`TelegramMessageEntity`](../../../../gramio/interfaces/TelegramMessageEntity.md)\[]

Defined in: contexts/index.d.ts:4214

*Optional*. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of *text\_parse\_mode*

##### Returns

[`TelegramMessageEntity`](../../../../gramio/interfaces/TelegramMessageEntity.md)\[]

***

### textParseMode

#### Get Signature

> **get** **textParseMode**(): `"HTML"` | `"MarkdownV2"` | `"Markdown"`

Defined in: contexts/index.d.ts:4210

*Optional*. Mode for parsing entities in the text. See [formatting options](https://core.telegram.org/bots/api/#formatting-options) for more details. Currently, only custom emoji entities are allowed

##### Returns

`"HTML"` | `"MarkdownV2"` | `"Markdown"`

---

---
url: 'https://gramio.dev/api/contexts/classes/Invoice.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Invoice

# Class: Invoice

Defined in: contexts/index.d.ts:1632

This object contains basic information about an invoice.

## Constructors

### Constructor

> **new Invoice**(`payload`): `Invoice`

Defined in: contexts/index.d.ts:1634

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramInvoice`](../../../../gramio/interfaces/TelegramInvoice.md) |

#### Returns

`Invoice`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramInvoice`](../../../../gramio/interfaces/TelegramInvoice.md) | contexts/index.d.ts:1633 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1636

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### currency

#### Get Signature

> **get** **currency**(): [`TelegramCurrencies`](../../../../gramio/type-aliases/TelegramCurrencies.md)

Defined in: contexts/index.d.ts:1647

Three-letter ISO 4217 currency code

##### Returns

[`TelegramCurrencies`](../../../../gramio/type-aliases/TelegramCurrencies.md)

***

### description

#### Get Signature

> **get** **description**(): `string`

Defined in: contexts/index.d.ts:1640

Product description

##### Returns

`string`

***

### startParameter

#### Get Signature

> **get** **startParameter**(): `string`

Defined in: contexts/index.d.ts:1645

Unique bot deep-linking parameter that can be used to generate this
invoice

##### Returns

`string`

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:1638

Product name

##### Returns

`string`

***

### totalAmount

#### Get Signature

> **get** **totalAmount**(): `number`

Defined in: contexts/index.d.ts:1656

Total price in the smallest units of the currency
(integer, not float/double). For example, for a price of
`US$ 1.45` pass `amount = 145`. See the `exp` parameter in
[currencies.json](https://core.telegram.org/bots/payments/currencies.json),
it shows the number of digits past the decimal point for each currency
(2 for the majority of currencies).

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/InvoiceContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / InvoiceContext

# Class: InvoiceContext\<Bot>

Defined in: contexts/index.d.ts:5951

Message is an invoice for a [payment](https://core.telegram.org/bots/api/#payments), information about the invoice. [More about payments »](https://core.telegram.org/bots/api/#payments)

[Documentation](https://core.telegram.org/bots/api/#invoice)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`InvoiceContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `InvoiceContext`<`Bot`>, `InvoiceContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new InvoiceContext**<`Bot`>(`options`): `InvoiceContext`<`Bot`>

Defined in: contexts/index.d.ts:5954

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `InvoiceContextOptions`<`Bot`> |

#### Returns

`InvoiceContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new InvoiceContext**(...`args`): `InvoiceContext`

Defined in: contexts/index.d.ts:5951

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`InvoiceContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5953 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventInvoice

#### Get Signature

> **get** **eventInvoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:5956

Invoice

##### Returns

[`Invoice`](Invoice.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `InvoiceContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `InvoiceContextOptions` |

#### Returns

`InvoiceContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<InvoiceContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<InvoiceContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<InvoiceContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<InvoiceContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<InvoiceContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<InvoiceContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<InvoiceContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<InvoiceContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<InvoiceContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<InvoiceContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<InvoiceContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<InvoiceContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/keyboards/classes/Keyboard.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / Keyboard

# Class: Keyboard

Defined in: keyboards/index.d.ts:178

**ReplyKeyboardMarkup** builder

This object represents a [custom keyboard](https://core.telegram.org/bots/features#keyboards) with reply options (see [Introduction to bots](https://core.telegram.org/bots/features#keyboards) for details and examples).

[\[Documentation\]](https://core.telegram.org/bots/api/#replykeyboardmarkup)

## Extends

* [`BaseKeyboardConstructor`](BaseKeyboardConstructor.md)<[`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)>

## Constructors

### Constructor

> **new Keyboard**(`featureFlags?`): `Keyboard`

Defined in: keyboards/index.d.ts:48

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `featureFlags?` | [`KeyboardFeatureFlags`](../interfaces/KeyboardFeatureFlags.md) |

#### Returns

`Keyboard`

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`constructor`](BaseKeyboardConstructor.md#constructor)

## Properties

| Property | Modifier | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `currentRow` | `protected` | [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)\[] | [`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`currentRow`](BaseKeyboardConstructor.md#currentrow) | keyboards/index.d.ts:46 |
|  `featureFlags` | `protected` | [`KeyboardFeatureFlags`](../interfaces/KeyboardFeatureFlags.md) | [`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`featureFlags`](BaseKeyboardConstructor.md#featureflags) | keyboards/index.d.ts:47 |
|  `options` | `public` | `object` | - | keyboards/index.d.ts:179 |
| `options.isOneTime` | `public` | `boolean` | - | keyboards/index.d.ts:180 |
| `options.isPersistent` | `public` | `boolean` | - | keyboards/index.d.ts:181 |
| `options.isResized` | `public` | `boolean` | - | keyboards/index.d.ts:182 |
| `options.isSelective` | `public` | `boolean` | - | keyboards/index.d.ts:183 |
| `options.placeholder` | `public` | `string` | - | keyboards/index.d.ts:184 |
|  `rows` | `protected` | [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)\[]\[] | [`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`rows`](BaseKeyboardConstructor.md#rows) | keyboards/index.d.ts:45 |

## Accessors

### keyboard

#### Get Signature

> **get** `protected` **keyboard**(): `T`\[]\[]

Defined in: keyboards/index.d.ts:52

##### Returns

`T`\[]\[]

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`keyboard`](BaseKeyboardConstructor.md#keyboard)

## Methods

### add()

> **add**(...`buttons`): `this`

Defined in: keyboards/index.d.ts:127

Allows you to add multiple buttons in raw format.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`buttons` | [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)\[] |

#### Returns

`this`

#### Example

```ts
const labels = ["some", "buttons"];

new InlineKeyboard()
    .add({ text: "raw button", callback_data: "payload" })
    .add(InlineKeyboard.text("raw button by InlineKeyboard.text", "payload"))
    .add(...labels.map((x) => InlineKeyboard.text(x, `${x}payload`)));
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`add`](BaseKeyboardConstructor.md#add)

***

### addIf()

> **addIf**(`condition`, ...`buttons`): `this`

Defined in: keyboards/index.d.ts:147

Allows you to dynamically substitute buttons depending on something

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `condition` | `boolean` | (`options`) => `boolean` |
| ...`buttons` | [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)\[] |

#### Returns

`this`

#### Example

```ts
const labels = ["some", "buttons"];
const isAdmin = true;

new InlineKeyboard()
    .addIf(1 === 2, { text: "raw button", callback_data: "payload" })
    .addIf(
        isAdmin,
        InlineKeyboard.text("raw button by InlineKeyboard.text", "payload")
    )
    .addIf(
        ({ index, rowIndex }) => rowIndex === index,
        ...labels.map((x) => InlineKeyboard.text(x, `${x}payload`))
    );
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`addIf`](BaseKeyboardConstructor.md#addif)

***

### build()

> **build**(): [`TelegramReplyKeyboardMarkup`](../../../../gramio/interfaces/TelegramReplyKeyboardMarkup.md)

Defined in: keyboards/index.d.ts:348

Return [TelegramReplyKeyboardMarkup](../../../../gramio/interfaces/TelegramReplyKeyboardMarkup.md) as object

#### Returns

[`TelegramReplyKeyboardMarkup`](../../../../gramio/interfaces/TelegramReplyKeyboardMarkup.md)

***

### columns()

> **columns**(`length?`): `this`

Defined in: keyboards/index.d.ts:75

Allows you to limit the number of columns in the keyboard.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `length?` | `number` |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .columns(1)
    .text("first row", "payload")
    .text("second row", "payload");
    .text("third row", "payload");
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`columns`](BaseKeyboardConstructor.md#columns)

***

### combine()

> **combine**(`keyboard`): `this`

Defined in: keyboards/index.d.ts:342

Allows you to combine keyboards. Only keyboards are combined. You need to call the `.row()` method to line-break after combine.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `keyboard` | [`TelegramReplyKeyboardMarkup`](../../../../gramio/interfaces/TelegramReplyKeyboardMarkup.md) | [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)\[]\[] | { `toJSON`: () => [`TelegramReplyKeyboardMarkup`](../../../../gramio/interfaces/TelegramReplyKeyboardMarkup.md); } |

#### Returns

`this`

#### Example

```ts
new Keyboard()
			.combine(new Keyboard().text("first"))
			.row()
			.combine(new Keyboard().text("second").row().text("third"))
```

***

### filter()

> **filter**(`fn?`): `this`

Defined in: keyboards/index.d.ts:99

A handler that helps filter keyboard buttons

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `fn?` | [`ButtonsIterator`](../type-aliases/ButtonsIterator.md)<[`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)> |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .filter(({ button }) => button.callback_data !== "hidden")
    .text("button", "pass")
    .text("button", "hidden")
    .text("button", "pass");
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`filter`](BaseKeyboardConstructor.md#filter)

***

### matrix()

> **matrix**(`rows`, `columns`, `fn`): `this`

Defined in: keyboards/index.d.ts:167

Allows you to create a button matrix.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rows` | `number` |
| `columns` | `number` |
| `fn` | [`CreateButtonIterator`](../type-aliases/CreateButtonIterator.md)<[`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)> |

#### Returns

`this`

#### Example

```ts
import { randomInt } from "node:crypto";

const bomb = [randomInt(0, 9), randomInt(0, 9)] as const;

new InlineKeyboard().matrix(10, 10, ({ rowIndex, index }) =>
   InlineKeyboard.text(
       rowIndex === bomb[0] && index === bomb[1] ? "💣" : "ㅤ",
       "payload"
   )
);
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`matrix`](BaseKeyboardConstructor.md#matrix)

***

### oneTime()

> **oneTime**(`isEnabled?`): `this`

Defined in: keyboards/index.d.ts:290

Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to *false*.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `isEnabled?` | `boolean` |

#### Returns

`this`

#### Example

```ts
new Keyboard().text("some text").oneTime(); // to enable
new Keyboard().text("some text").oneTime(false); // to disable
```

***

### pattern()

> **pattern**(`pattern?`): `this`

Defined in: keyboards/index.d.ts:114

An array with the number of columns per row. Allows you to set a "template"

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `pattern?` | `number`\[] |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .pattern([1, 3, 2])
    .text("1", "payload")
    .text("2", "payload")
    .text("2", "payload")
    .text("2", "payload")
    .text("3", "payload")
    .text("3", "payload");
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`pattern`](BaseKeyboardConstructor.md#pattern)

***

### persistent()

> **persistent**(`isEnabled?`): `this`

Defined in: keyboards/index.d.ts:299

Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to *false*, in which case the custom keyboard can be hidden and opened with a keyboard icon.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `isEnabled?` | `boolean` |

#### Returns

`this`

#### Example

```ts
new Keyboard().text("some text").persistent(); // to enable
new Keyboard().text("some text").persistent(false); // to disable
```

***

### placeholder()

> **placeholder**(`value?`): `this`

Defined in: keyboards/index.d.ts:308

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `value?` | `string` |

#### Returns

`this`

#### Example

```ts
new Keyboard().text("some text").placeholder("some text"); // to enable
new Keyboard().text("some text").placeholder(); // to disable
```

***

### requestChat()

> **requestChat**(`text`, `requestId`, `options?`, `buttonOptions?`): `this`

Defined in: keyboards/index.d.ts:221

If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat\_shared” service message. Available in private chats only.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `requestId` | `number` |
| `options?` | `Omit`<[`TelegramKeyboardButtonRequestChat`](../../../../gramio/interfaces/TelegramKeyboardButtonRequestChat.md), `"request_id"` | `"chat_is_channel"`> & `object` |
| `buttonOptions?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new Keyboard().requestChat("gramio", 255, {
    chat_is_forum: true,
});
```

***

### requestContact()

> **requestContact**(`text`, `options?`): `this`

Defined in: keyboards/index.d.ts:237

If *True*, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new Keyboard().requestContact("some button text");
```

***

### requestLocation()

> **requestLocation**(`text`, `options?`): `this`

Defined in: keyboards/index.d.ts:249

If *True*, the user's current location will be sent when the button is pressed. Available in private chats only.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new Keyboard().requestLocation("some button text");
```

***

### requestPoll()

> **requestPoll**(`text`, `type?`, `options?`): `this`

Defined in: keyboards/index.d.ts:263

If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

If *quiz* is passed, the user will be allowed to create only polls in the quiz mode. If *regular* is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `type?` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new Keyboard().requestPoll("some button text", "quiz");
```

***

### requestUsers()

> **requestUsers**(`text`, `requestId`, `options?`, `buttonOptions?`): `this`

Defined in: keyboards/index.d.ts:207

If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users\_shared” service message. Available in private chats only.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `requestId` | `number` |
| `options?` | `Omit`<[`TelegramKeyboardButtonRequestUsers`](../../../../gramio/interfaces/TelegramKeyboardButtonRequestUsers.md), `"request_id"`> |
| `buttonOptions?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new Keyboard().requestUsers("some button text", 228, {
    user_is_premium: true,
});
```

***

### resetHelpers()

> **resetHelpers**(): `this`

Defined in: keyboards/index.d.ts:168

#### Returns

`this`

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`resetHelpers`](BaseKeyboardConstructor.md#resethelpers)

***

### resized()

> **resized**(`isEnabled?`): `this`

Defined in: keyboards/index.d.ts:319

!**Note** Keyboard is resized by default! For disable it you can use `.resized(false)`

Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to *false*, in which case the custom keyboard is always of the same height as the app's standard keyboard.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `isEnabled?` | `boolean` |

#### Returns

`this`

#### Example

```ts
new Keyboard().text("some text").resized(); // to enable
new Keyboard().text("some text").resized(false); // to disable
```

***

### row()

> **row**(): `this`

Defined in: keyboards/index.d.ts:63

Adds a `line break`. Call this method to make sure that the next added buttons will be on a new row.

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .text("first row", "payload")
    .row()
    .text("second row", "payload");
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`row`](BaseKeyboardConstructor.md#row)

***

### selective()

> **selective**(`isEnabled?`): `this`

Defined in: keyboards/index.d.ts:330

Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the *text* of the [Message](https://core.telegram.org/bots/api/#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.

*Example:* A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `isEnabled?` | `boolean` |

#### Returns

`this`

#### Example

```ts
new Keyboard().text("some text").selective(); // to enable
new Keyboard().text("some text").selective(false); // to disable
```

***

### text()

> **text**(`text`, `options?`): `this`

Defined in: keyboards/index.d.ts:193

Text of the button. It will be sent as a message when the button is pressed

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new Keyboard().text("some button text");
```

***

### toJSON()

> **toJSON**(): [`TelegramReplyKeyboardMarkup`](../../../../gramio/interfaces/TelegramReplyKeyboardMarkup.md)

Defined in: keyboards/index.d.ts:352

Serializing a class into an [TelegramReplyKeyboardMarkup](../../../../gramio/interfaces/TelegramReplyKeyboardMarkup.md) object (used by JSON.stringify)

#### Returns

[`TelegramReplyKeyboardMarkup`](../../../../gramio/interfaces/TelegramReplyKeyboardMarkup.md)

***

### webApp()

> **webApp**(`text`, `url`, `options?`): `this`

Defined in: keyboards/index.d.ts:277

If specified, the described [Web App](https://core.telegram.org/bots/webapps) will be launched when the button is pressed. The Web App will be able to send a “web\_app\_data” service message. Available in private chats only.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `url` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new Keyboard().webApp("some button text", "https://...");
```

***

### wrap()

> **wrap**(`fn?`): `this`

Defined in: keyboards/index.d.ts:87

A custom handler that controls row wrapping.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `fn?` | [`ButtonsIterator`](../type-aliases/ButtonsIterator.md)<[`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)> |

#### Returns

`this`

#### Example

```ts
new InlineKeyboard()
    .wrap(({ button }) => button.callback_data === "2")
    .text("first row", "1")
    .text("first row", "1");
    .text("second row", "2");
```

#### Inherited from

[`BaseKeyboardConstructor`](BaseKeyboardConstructor.md).[`wrap`](BaseKeyboardConstructor.md#wrap)

***

### requestChat()

> `static` **requestChat**(`text`, `requestId`, `options?`, `buttonOptions?`): [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

Defined in: keyboards/index.d.ts:227

If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat\_shared” service message. Available in private chats only.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `requestId` | `number` |
| `options?` | `Omit`<[`TelegramKeyboardButtonRequestChat`](../../../../gramio/interfaces/TelegramKeyboardButtonRequestChat.md), `"request_id"` | `"chat_is_channel"`> & `object` |
| `buttonOptions?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

***

### requestContact()

> `static` **requestContact**(`text`, `options?`): [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

Defined in: keyboards/index.d.ts:241

If *True*, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

***

### requestLocation()

> `static` **requestLocation**(`text`, `options?`): [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

Defined in: keyboards/index.d.ts:253

If *True*, the user's current location will be sent when the button is pressed. Available in private chats only.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

***

### requestPoll()

> `static` **requestPoll**(`text`, `type?`, `options?`): [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

Defined in: keyboards/index.d.ts:269

If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

If *quiz* is passed, the user will be allowed to create only polls in the quiz mode. If *regular* is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `type?` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

***

### requestUsers()

> `static` **requestUsers**(`text`, `requestId`, `options?`, `buttonOptions?`): [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

Defined in: keyboards/index.d.ts:211

If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users\_shared” service message. Available in private chats only.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `requestId` | `number` |
| `options?` | `Omit`<[`TelegramKeyboardButtonRequestUsers`](../../../../gramio/interfaces/TelegramKeyboardButtonRequestUsers.md), `"request_id"`> |
| `buttonOptions?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

***

### text()

> `static` **text**(`text`, `options?`): [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

Defined in: keyboards/index.d.ts:197

Text of the button. It will be sent as a message when the button is pressed

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

***

### webApp()

> `static` **webApp**(`text`, `url`, `options?`): [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

Defined in: keyboards/index.d.ts:281

If specified, the described [Web App](https://core.telegram.org/bots/webapps) will be launched when the button is pressed. The Web App will be able to send a “web\_app\_data” service message. Available in private chats only.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `url` | `string` |
| `options?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

[`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/LeftChatMemberContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / LeftChatMemberContext

# Class: LeftChatMemberContext\<Bot>

Defined in: contexts/index.d.ts:5968

A member was removed from the group, information about them (this member may be the bot itself)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`LeftChatMemberContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `LeftChatMemberContext`<`Bot`>, `LeftChatMemberContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new LeftChatMemberContext**<`Bot`>(`options`): `LeftChatMemberContext`<`Bot`>

Defined in: contexts/index.d.ts:5971

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `LeftChatMemberContextOptions`<`Bot`> |

#### Returns

`LeftChatMemberContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new LeftChatMemberContext**(...`args`): `LeftChatMemberContext`

Defined in: contexts/index.d.ts:5968

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`LeftChatMemberContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5970 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventMember

#### Get Signature

> **get** **eventMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:5973

Left chat member

##### Returns

[`User`](User.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `LeftChatMemberContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `LeftChatMemberContextOptions` |

#### Returns

`LeftChatMemberContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<LeftChatMemberContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<LeftChatMemberContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<LeftChatMemberContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<LeftChatMemberContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<LeftChatMemberContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<LeftChatMemberContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<LeftChatMemberContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<LeftChatMemberContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<LeftChatMemberContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<LeftChatMemberContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<LeftChatMemberContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<LeftChatMemberContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/LinkPreviewOptions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / LinkPreviewOptions

# Class: LinkPreviewOptions

Defined in: contexts/index.d.ts:1660

Describes the options used for link preview generation.

## Constructors

### Constructor

> **new LinkPreviewOptions**(`payload`): `LinkPreviewOptions`

Defined in: contexts/index.d.ts:1662

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramLinkPreviewOptions`](../../../../gramio/interfaces/TelegramLinkPreviewOptions.md) |

#### Returns

`LinkPreviewOptions`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramLinkPreviewOptions`](../../../../gramio/interfaces/TelegramLinkPreviewOptions.md) | contexts/index.d.ts:1661 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1664

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### url

#### Get Signature

> **get** **url**(): `string`

Defined in: contexts/index.d.ts:1668

URL to use for the link preview. If empty, then the first URL found in the message text will be used

##### Returns

`string`

## Methods

### isDisabled()

> **isDisabled**(): `boolean`

Defined in: contexts/index.d.ts:1666

`true`, if the link preview is disabled

#### Returns

`boolean`

***

### preferLargeMedia()

> **preferLargeMedia**(): `boolean`

Defined in: contexts/index.d.ts:1672

`true`, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview

#### Returns

`boolean`

***

### preferSmallMedia()

> **preferSmallMedia**(): `boolean`

Defined in: contexts/index.d.ts:1670

`true`, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview

#### Returns

`boolean`

***

### showAboveText()

> **showAboveText**(): `boolean`

Defined in: contexts/index.d.ts:1674

`true`, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text

#### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/contexts/classes/Location.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Location

# Class: Location

Defined in: contexts/index.d.ts:423

This object represents a point on the map.

## Extended by

* [`LocationAttachment`](LocationAttachment.md)

## Constructors

### Constructor

> **new Location**(`payload`): `Location`

Defined in: contexts/index.d.ts:425

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramLocation`](../../../../gramio/interfaces/TelegramLocation.md) |

#### Returns

`Location`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramLocation`](../../../../gramio/interfaces/TelegramLocation.md) | contexts/index.d.ts:424 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:427

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### heading

#### Get Signature

> **get** **heading**(): `number`

Defined in: contexts/index.d.ts:444

The direction in which user is moving, in degrees; `1-360`.
For active live locations only.

##### Returns

`number`

***

### horizontalAccuracy

#### Get Signature

> **get** **horizontalAccuracy**(): `number`

Defined in: contexts/index.d.ts:433

The radius of uncertainty for the location, measured in meters; `0-1500`

##### Returns

`number`

***

### latitude

#### Get Signature

> **get** **latitude**(): `number`

Defined in: contexts/index.d.ts:431

Latitude as defined by sender

##### Returns

`number`

***

### livePeriod

#### Get Signature

> **get** **livePeriod**(): `number`

Defined in: contexts/index.d.ts:439

Time relative to the message sending date,
during which the location can be updated, in seconds.
For active live locations only.

##### Returns

`number`

***

### longitude

#### Get Signature

> **get** **longitude**(): `number`

Defined in: contexts/index.d.ts:429

Longitude as defined by sender

##### Returns

`number`

***

### proximityAlertRadius

#### Get Signature

> **get** **proximityAlertRadius**(): `number`

Defined in: contexts/index.d.ts:449

Maximum distance for proximity alerts about approaching another chat member, in meters.
For sent live locations only.

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/LocationAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / LocationAttachment

# Class: LocationAttachment

Defined in: contexts/index.d.ts:453

This object represents a point on the map.

## Extends

* [`Location`](Location.md).[`Attachment`](Attachment.md)

## Constructors

### Constructor

> **new LocationAttachment**(`payload`): `LocationAttachment`

Defined in: contexts/index.d.ts:425

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramLocation`](../../../../gramio/interfaces/TelegramLocation.md) |

#### Returns

`LocationAttachment`

#### Inherited from

[`Location`](Location.md).[`constructor`](Location.md#constructor)

## Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
|  `attachmentType` | [`AttachmentType`](../type-aliases/AttachmentType.md) | [`Attachment`](Attachment.md).[`attachmentType`](Attachment.md#attachmenttype) | contexts/index.d.ts:454 |
|  `payload` | [`TelegramLocation`](../../../../gramio/interfaces/TelegramLocation.md) | [`Location`](Location.md).[`payload`](Location.md#payload) | contexts/index.d.ts:424 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:427

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Location`](Location.md).[`[toStringTag]`](Location.md#tostringtag)

***

### heading

#### Get Signature

> **get** **heading**(): `number`

Defined in: contexts/index.d.ts:444

The direction in which user is moving, in degrees; `1-360`.
For active live locations only.

##### Returns

`number`

#### Inherited from

[`Location`](Location.md).[`heading`](Location.md#heading)

***

### horizontalAccuracy

#### Get Signature

> **get** **horizontalAccuracy**(): `number`

Defined in: contexts/index.d.ts:433

The radius of uncertainty for the location, measured in meters; `0-1500`

##### Returns

`number`

#### Inherited from

[`Location`](Location.md).[`horizontalAccuracy`](Location.md#horizontalaccuracy)

***

### latitude

#### Get Signature

> **get** **latitude**(): `number`

Defined in: contexts/index.d.ts:431

Latitude as defined by sender

##### Returns

`number`

#### Inherited from

[`Location`](Location.md).[`latitude`](Location.md#latitude)

***

### livePeriod

#### Get Signature

> **get** **livePeriod**(): `number`

Defined in: contexts/index.d.ts:439

Time relative to the message sending date,
during which the location can be updated, in seconds.
For active live locations only.

##### Returns

`number`

#### Inherited from

[`Location`](Location.md).[`livePeriod`](Location.md#liveperiod)

***

### longitude

#### Get Signature

> **get** **longitude**(): `number`

Defined in: contexts/index.d.ts:429

Longitude as defined by sender

##### Returns

`number`

#### Inherited from

[`Location`](Location.md).[`longitude`](Location.md#longitude)

***

### proximityAlertRadius

#### Get Signature

> **get** **proximityAlertRadius**(): `number`

Defined in: contexts/index.d.ts:449

Maximum distance for proximity alerts about approaching another chat member, in meters.
For sent live locations only.

##### Returns

`number`

#### Inherited from

[`Location`](Location.md).[`proximityAlertRadius`](Location.md#proximityalertradius)

---

---
url: 'https://gramio.dev/api/contexts/classes/LocationContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / LocationContext

# Class: LocationContext\<Bot>

Defined in: contexts/index.d.ts:5989

This object represents a point on the map.

[Documentation](https://core.telegram.org/bots/api/#location)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`LocationContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `LocationContext`<`Bot`>, `LocationContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new LocationContext**<`Bot`>(`options`): `LocationContext`<`Bot`>

Defined in: contexts/index.d.ts:5992

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `LocationContextOptions`<`Bot`> |

#### Returns

`LocationContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new LocationContext**(...`args`): `LocationContext`

Defined in: contexts/index.d.ts:5989

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`LocationContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:5991 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventLocation

#### Get Signature

> **get** **eventLocation**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:5994

Location

##### Returns

[`Location`](Location.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `LocationContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `LocationContextOptions` |

#### Returns

`LocationContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<LocationContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<LocationContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<LocationContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<LocationContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<LocationContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<LocationContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<LocationContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<LocationContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<LocationContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<LocationContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<LocationContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<LocationContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/LoginUrl.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / LoginUrl

# Class: LoginUrl

Defined in: contexts/index.d.ts:1950

This object represents a parameter of the inline keyboard button used to
automatically authorize a user.

## Constructors

### Constructor

> **new LoginUrl**(`payload`): `LoginUrl`

Defined in: contexts/index.d.ts:1952

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramLoginUrl`](../../../../gramio/interfaces/TelegramLoginUrl.md) |

#### Returns

`LoginUrl`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramLoginUrl`](../../../../gramio/interfaces/TelegramLoginUrl.md) | contexts/index.d.ts:1951 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1954

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### botUsername

#### Get Signature

> **get** **botUsername**(): `string`

Defined in: contexts/index.d.ts:1976

Username of a bot, which will be used for user authorization.
See Setting up a bot for more details. If not specified, the current
bot's username will be assumed. The url's domain must be the same as the
domain linked with the bot. See Linking your domain to the bot for more
details.

##### Returns

`string`

***

### forwardText

#### Get Signature

> **get** **forwardText**(): `string`

Defined in: contexts/index.d.ts:1968

New text of the button in forwarded messages.

##### Returns

`string`

***

### requestWriteAccess

#### Get Signature

> **get** **requestWriteAccess**(): `boolean`

Defined in: contexts/index.d.ts:1981

Pass `true` to request the permission for your bot to send messages to the
user.

##### Returns

`boolean`

***

### url

#### Get Signature

> **get** **url**(): `string`

Defined in: contexts/index.d.ts:1966

An HTTP URL to be opened with user authorization data added to the query
string when the button is pressed. If the user refuses to provid
authorization data, the original URL without information about the user
will be opened. The data added is the same as described in Receiving
authorization data.

**NOTE**: You **must** always check the hash of the received data to
verify the authentication and the integrity of the data as described in
Checking authorization.

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/MaskPosition.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MaskPosition

# Class: MaskPosition

Defined in: contexts/index.d.ts:688

This object describes the position on faces where a mask should be placed
by default.

## Constructors

### Constructor

> **new MaskPosition**(`payload`): `MaskPosition`

Defined in: contexts/index.d.ts:690

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramMaskPosition`](../../../../gramio/interfaces/TelegramMaskPosition.md) |

#### Returns

`MaskPosition`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramMaskPosition`](../../../../gramio/interfaces/TelegramMaskPosition.md) | contexts/index.d.ts:689 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:692

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### point

#### Get Signature

> **get** **point**(): [`TelegramMaskPositionPoint`](../../../../gramio/type-aliases/TelegramMaskPositionPoint.md)

Defined in: contexts/index.d.ts:697

The part of the face relative to which the mask should be placed.
One of `forehead`, `eyes`, `mouth`, or `chin`.

##### Returns

[`TelegramMaskPositionPoint`](../../../../gramio/type-aliases/TelegramMaskPositionPoint.md)

***

### scale

#### Get Signature

> **get** **scale**(): `number`

Defined in: contexts/index.d.ts:711

Mask scaling coefficient. For example, `2.0` means double size.

##### Returns

`number`

***

### xShift

#### Get Signature

> **get** **xShift**(): `number`

Defined in: contexts/index.d.ts:703

Shift by X-axis measured in widths of the mask scaled to the face size,
from left to right. For example, choosing `-1.0` will place mask just to
the left of the default mask position.

##### Returns

`number`

***

### yShift

#### Get Signature

> **get** **yShift**(): `number`

Defined in: contexts/index.d.ts:709

Shift by Y-axis measured in heights of the mask scaled to the face size,
from top to bottom. For example, `1.0` will place the mask just below the
default mask position.

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/files/classes/MediaInput.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/files/dist](../index.md) / MediaInput

# Class: MediaInput

Defined in: files/index.d.ts:48

Class-helper with static methods that represents the content of a media message to be sent.

[Documentation](https://gramio.dev/files/media-input.html)

## Constructors

### Constructor

> **new MediaInput**(): `MediaInput`

#### Returns

`MediaInput`

## Methods

### animation()

> `static` **animation**(`media`, `options?`): [`TelegramInputMediaAnimation`](../../../../gramio/interfaces/TelegramInputMediaAnimation.md)

Defined in: files/index.d.ts:54

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

[Documentation](https://core.telegram.org/bots/api/#inputmediaanimation)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | `string` | `Blob` |
| `options?` | `Omit`<[`TelegramInputMediaAnimation`](../../../../gramio/interfaces/TelegramInputMediaAnimation.md), `"media"` | `"type"`> |

#### Returns

[`TelegramInputMediaAnimation`](../../../../gramio/interfaces/TelegramInputMediaAnimation.md)

***

### audio()

> `static` **audio**(`media`, `options?`): [`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md)

Defined in: files/index.d.ts:66

Represents an audio file to be treated as music to be sent.

[Documentation](https://core.telegram.org/bots/api/#inputmediaaudio)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | `string` | `Blob` |
| `options?` | `Omit`<[`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md), `"media"` | `"type"`> |

#### Returns

[`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md)

***

### document()

> `static` **document**(`media`, `options?`): [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md)

Defined in: files/index.d.ts:60

Represents a general file to be sent.

[Documentation](https://core.telegram.org/bots/api/#inputmediadocument)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | `string` | `Blob` |
| `options?` | `Omit`<[`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md), `"media"` | `"type"`> |

#### Returns

[`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md)

***

### photo()

> `static` **photo**(`media`, `options?`): [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md)

Defined in: files/index.d.ts:72

Represents a photo to be sent.

[Documentation](https://core.telegram.org/bots/api/#inputmediaphoto)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | `string` | `Blob` |
| `options?` | `Omit`<[`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md), `"media"` | `"type"`> |

#### Returns

[`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md)

***

### video()

> `static` **video**(`media`, `options?`): [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md)

Defined in: files/index.d.ts:78

Represents a video to be sent.

[Documentation](https://core.telegram.org/bots/api/#inputmediavideo)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | `string` | `Blob` |
| `options?` | `Omit`<[`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md), `"media"` | `"type"`> |

#### Returns

[`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md)

---

---
url: 'https://gramio.dev/api/files/classes/MediaUpload.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/files/dist](../index.md) / MediaUpload

# Class: MediaUpload

Defined in: files/index.d.ts:86

Class-helper with static methods for file uploading.

[Documentation](https://gramio.dev/files/media-upload.html)

## Constructors

### Constructor

> **new MediaUpload**(): `MediaUpload`

#### Returns

`MediaUpload`

## Methods

### buffer()

> `static` **buffer**(`buffer`, `filename?`): `File`

Defined in: files/index.d.ts:98

Method for uploading Media File by BinaryLike (Buffer or ArrayBuffer and etc).

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `buffer` | `any` |
| `filename?` | `string` |

#### Returns

`File`

***

### path()

> `static` **path**(`path`, `filename?`): `Promise`<`File`>

Defined in: files/index.d.ts:90

Method for uploading Media File by local path.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `path` | `string` |
| `filename?` | `string` |

#### Returns

`Promise`<`File`>

***

### stream()

> `static` **stream**(`stream`, `filename?`): `Promise`<`File`>

Defined in: files/index.d.ts:94

Method for uploading Media File by Readable stream.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Readable` | `ReadableStream`<`any`> |
| `filename?` | `string` |

#### Returns

`Promise`<`File`>

***

### text()

> `static` **text**(`text`, `filename?`): `File`

Defined in: files/index.d.ts:106

Method for uploading Media File by text content.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `filename?` | `string` |

#### Returns

`File`

***

### url()

> `static` **url**(`url`, `filename?`, `options?`): `Promise`<`File`>

Defined in: files/index.d.ts:102

Method for uploading Media File by URL (also with fetch options).

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `url` | `string` | `URL` |
| `filename?` | `string` |
| `options?` | `RequestInit` |

#### Returns

`Promise`<`File`>

---

---
url: 'https://gramio.dev/api/contexts/classes/MenuButton.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MenuButton

# Class: MenuButton

Defined in: contexts/index.d.ts:4228

This object describes the bot's menu button in a private chat.

## Constructors

### Constructor

> **new MenuButton**(`payload`): `MenuButton`

Defined in: contexts/index.d.ts:4230

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `Record`<`string`, `any`> & [`TelegramMenuButtonCommands`](../../../../gramio/interfaces/TelegramMenuButtonCommands.md) | `Record`<`string`, `any`> & [`TelegramMenuButtonWebApp`](../../../../gramio/interfaces/TelegramMenuButtonWebApp.md) | `Record`<`string`, `any`> & [`TelegramMenuButtonDefault`](../../../../gramio/interfaces/TelegramMenuButtonDefault.md) |

#### Returns

`MenuButton`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | `Record`<`string`, `any`> & [`TelegramMenuButtonCommands`](../../../../gramio/interfaces/TelegramMenuButtonCommands.md) | `Record`<`string`, `any`> & [`TelegramMenuButtonWebApp`](../../../../gramio/interfaces/TelegramMenuButtonWebApp.md) | `Record`<`string`, `any`> & [`TelegramMenuButtonDefault`](../../../../gramio/interfaces/TelegramMenuButtonDefault.md) | contexts/index.d.ts:4229 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4232

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### text

#### Get Signature

> **get** **text**(): `any`

Defined in: contexts/index.d.ts:4236

Text on the button

##### Returns

`any`

***

### type

#### Get Signature

> **get** **type**(): `"default"` | `"commands"` | `"web_app"`

Defined in: contexts/index.d.ts:4234

Type of the button

##### Returns

`"default"` | `"commands"` | `"web_app"`

***

### webApp

#### Get Signature

> **get** **webApp**(): [`WebAppInfo`](WebAppInfo.md)

Defined in: contexts/index.d.ts:4242

Description of the Web App that will be launched when the user presses the button.
The Web App will be able to send an arbitrary message on behalf of the user
using the method `answerWebAppQuery`.

##### Returns

[`WebAppInfo`](WebAppInfo.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/Message.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Message

# Class: Message

Defined in: contexts/index.d.ts:2908

This object represents a message.

## Extended by

* [`BoostAddedContext`](BoostAddedContext.md)
* [`ChatBackgroundSetContext`](ChatBackgroundSetContext.md)
* [`ChatOwnerChangedContext`](ChatOwnerChangedContext.md)
* [`ChatOwnerLeftContext`](ChatOwnerLeftContext.md)
* [`ChatSharedContext`](ChatSharedContext.md)
* [`ChecklistTasksAddedContext`](ChecklistTasksAddedContext.md)
* [`ChecklistTasksDoneContext`](ChecklistTasksDoneContext.md)
* [`DeleteChatPhotoContext`](DeleteChatPhotoContext.md)
* [`DirectMessagePriceChangedContext`](DirectMessagePriceChangedContext.md)
* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiftContext`](GiftContext.md)
* [`GiftUpgradeSentContext`](GiftUpgradeSentContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)
* [`GroupChatCreatedContext`](GroupChatCreatedContext.md)
* [`InvoiceContext`](InvoiceContext.md)
* [`LeftChatMemberContext`](LeftChatMemberContext.md)
* [`LocationContext`](LocationContext.md)
* [`MessageAutoDeleteTimerChangedContext`](MessageAutoDeleteTimerChangedContext.md)
* [`MessageContext`](MessageContext.md)
* [`MigrateFromChatIdContext`](MigrateFromChatIdContext.md)
* [`MigrateToChatIdContext`](MigrateToChatIdContext.md)
* [`NewChatMembersContext`](NewChatMembersContext.md)
* [`NewChatPhotoContext`](NewChatPhotoContext.md)
* [`NewChatTitleContext`](NewChatTitleContext.md)
* [`PaidMessagePriceChangedContext`](PaidMessagePriceChangedContext.md)
* [`PassportDataContext`](PassportDataContext.md)
* [`PinnedMessageContext`](PinnedMessageContext.md)
* [`ProximityAlertTriggeredContext`](ProximityAlertTriggeredContext.md)
* [`RefundedPaymentContext`](RefundedPaymentContext.md)
* [`SuccessfulPaymentContext`](SuccessfulPaymentContext.md)
* [`SuggestedPostApprovalFailedContext`](SuggestedPostApprovalFailedContext.md)
* [`SuggestedPostApprovedContext`](SuggestedPostApprovedContext.md)
* [`SuggestedPostDeclinedContext`](SuggestedPostDeclinedContext.md)
* [`SuggestedPostPaidContext`](SuggestedPostPaidContext.md)
* [`SuggestedPostRefundedContext`](SuggestedPostRefundedContext.md)
* [`UniqueGiftContext`](UniqueGiftContext.md)
* [`UsersSharedContext`](UsersSharedContext.md)
* [`VideoChatEndedContext`](VideoChatEndedContext.md)
* [`VideoChatParticipantsInvitedContext`](VideoChatParticipantsInvitedContext.md)
* [`VideoChatScheduledContext`](VideoChatScheduledContext.md)
* [`VideoChatStartedContext`](VideoChatStartedContext.md)
* [`WebAppDataContext`](WebAppDataContext.md)
* [`WriteAccessAllowedContext`](WriteAccessAllowedContext.md)

## Constructors

### Constructor

> **new Message**(`payload`): `Message`

Defined in: contexts/index.d.ts:2910

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) |

#### Returns

`Message`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | contexts/index.d.ts:2909 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2912

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<`Message`, `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<`Message`, `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<`Message`, `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<`Message`, `"replyMessage"`>

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

## Methods

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/contexts/classes/MessageAutoDeleteTimerChanged.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageAutoDeleteTimerChanged

# Class: MessageAutoDeleteTimerChanged

Defined in: contexts/index.d.ts:2053

This object represents a service message about a change in auto-delete timer settings

## Constructors

### Constructor

> **new MessageAutoDeleteTimerChanged**(`payload`): `MessageAutoDeleteTimerChanged`

Defined in: contexts/index.d.ts:2055

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramMessageAutoDeleteTimerChanged`](../../../../gramio/interfaces/TelegramMessageAutoDeleteTimerChanged.md) |

#### Returns

`MessageAutoDeleteTimerChanged`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramMessageAutoDeleteTimerChanged`](../../../../gramio/interfaces/TelegramMessageAutoDeleteTimerChanged.md) | contexts/index.d.ts:2054 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2057

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### messageAutoDeleteTime

#### Get Signature

> **get** **messageAutoDeleteTime**(): `number`

Defined in: contexts/index.d.ts:2059

New auto-delete time for messages in the chat

##### Returns

`number`

---

---
url: >-
  https://gramio.dev/api/contexts/classes/MessageAutoDeleteTimerChangedContext.md
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageAutoDeleteTimerChangedContext

# Class: MessageAutoDeleteTimerChangedContext\<Bot>

Defined in: contexts/index.d.ts:6010

This object represents a service message about a change in auto-delete timer settings.

[Documentation](https://core.telegram.org/bots/api/#messageautodeletetimerchanged)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`MessageAutoDeleteTimerChangedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `MessageAutoDeleteTimerChangedContext`<`Bot`>, `MessageAutoDeleteTimerChangedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new MessageAutoDeleteTimerChangedContext**<`Bot`>(`options`): `MessageAutoDeleteTimerChangedContext`<`Bot`>

Defined in: contexts/index.d.ts:6013

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `MessageAutoDeleteTimerChangedContextOptions`<`Bot`> |

#### Returns

`MessageAutoDeleteTimerChangedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new MessageAutoDeleteTimerChangedContext**(...`args`): `MessageAutoDeleteTimerChangedContext`

Defined in: contexts/index.d.ts:6010

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`MessageAutoDeleteTimerChangedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6012 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### autoDeleteTimer

#### Get Signature

> **get** **autoDeleteTimer**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:6015

Message auto delete timer

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `MessageAutoDeleteTimerChangedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `MessageAutoDeleteTimerChangedContextOptions` |

#### Returns

`MessageAutoDeleteTimerChangedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<MessageAutoDeleteTimerChangedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<MessageAutoDeleteTimerChangedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<MessageAutoDeleteTimerChangedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<MessageAutoDeleteTimerChangedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<MessageAutoDeleteTimerChangedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<MessageAutoDeleteTimerChangedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<MessageAutoDeleteTimerChangedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<MessageAutoDeleteTimerChangedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<MessageAutoDeleteTimerChangedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<MessageAutoDeleteTimerChangedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<MessageAutoDeleteTimerChangedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<MessageAutoDeleteTimerChangedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/MessageContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageContext

# Class: MessageContext\<Bot>

Defined in: contexts/index.d.ts:4786

Called when `message` event occurs

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`MessageContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`DownloadMixin`](DownloadMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `MessageContext`<`Bot`>, `MessageContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new MessageContext**<`Bot`>(`options`): `MessageContext`<`Bot`>

Defined in: contexts/index.d.ts:4790

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `MessageContextOptions`<`Bot`> |

#### Returns

`MessageContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new MessageContext**(...`args`): `MessageContext`

Defined in: contexts/index.d.ts:4786

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`MessageContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:4789 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### attachment

#### Get Signature

> **get** **attachment**(): [`PhotoAttachment`](PhotoAttachment.md) | [`ContactAttachment`](ContactAttachment.md) | [`PollAttachment`](PollAttachment.md) | [`VenueAttachment`](VenueAttachment.md) | [`LocationAttachment`](LocationAttachment.md) | [`StickerAttachment`](StickerAttachment.md) | [`StoryAttachment`](StoryAttachment.md) | [`AnimationAttachment`](AnimationAttachment.md) | [`AudioAttachment`](AudioAttachment.md) | [`DocumentAttachment`](DocumentAttachment.md) | [`VideoAttachment`](VideoAttachment.md) | [`VideoNoteAttachment`](VideoNoteAttachment.md) | [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:4825

Message attachment

##### Returns

[`PhotoAttachment`](PhotoAttachment.md) | [`ContactAttachment`](ContactAttachment.md) | [`PollAttachment`](PollAttachment.md) | [`VenueAttachment`](VenueAttachment.md) | [`LocationAttachment`](LocationAttachment.md) | [`StickerAttachment`](StickerAttachment.md) | [`StoryAttachment`](StoryAttachment.md) | [`AnimationAttachment`](AnimationAttachment.md) | [`AudioAttachment`](AudioAttachment.md) | [`DocumentAttachment`](DocumentAttachment.md) | [`VideoAttachment`](VideoAttachment.md) | [`VideoNoteAttachment`](VideoNoteAttachment.md) | [`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`DownloadMixin`](DownloadMixin.md).[`attachment`](DownloadMixin.md#attachment)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:4802

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Set Signature

> **set** **caption**(`caption`): `void`

Defined in: contexts/index.d.ts:4803

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `string` |

##### Returns

`void`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventType

#### Get Signature

> **get** **eventType**(): [`MessageEventName`](../type-aliases/MessageEventName.md)

Defined in: contexts/index.d.ts:4835

Event type

##### Returns

[`MessageEventName`](../type-aliases/MessageEventName.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidMedia

#### Get Signature

> **get** **paidMedia**(): [`PaidMediaInfo`](PaidMediaInfo.md)

Defined in: contexts/index.d.ts:4823

##### Returns

[`PaidMediaInfo`](PaidMediaInfo.md)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### rawStartPayload

#### Get Signature

> **get** **rawStartPayload**(): `string`

Defined in: contexts/index.d.ts:4809

Value after the `/start` command

##### Returns

`string`

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### startPayload

#### Get Signature

> **get** **startPayload**(): `string` | `number`

Defined in: contexts/index.d.ts:4814

Parsed value ("1" => 1, `{"a": 1}` => {a: 1}) after the `/start` command

##### Deprecated

Use `rawStartPayload` instead. This property will be reworked and it will be the same as `rawStartPayload`

##### Returns

`string` | `number`

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:4794

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Set Signature

> **set** **text**(`text`): `void`

Defined in: contexts/index.d.ts:4795

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |

##### Returns

`void`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `MessageContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `MessageContextOptions` |

#### Returns

`MessageContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### download()

#### Call Signature

> **download**(): `Promise`<`ArrayBuffer`>

Defined in: contexts/index.d.ts:5284

Downloads attachment

##### Returns

`Promise`<`ArrayBuffer`>

##### Inherited from

[`DownloadMixin`](DownloadMixin.md).[`download`](DownloadMixin.md#download)

#### Call Signature

> **download**(`path`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5285

Downloads attachment

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `path` | `string` |

##### Returns

`Promise`<`string`>

##### Inherited from

[`DownloadMixin`](DownloadMixin.md).[`download`](DownloadMixin.md#download)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | `MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | `MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | `MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | `MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | `MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | `MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | `MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | `MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | `MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | `MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | `MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | `MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | `MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | `MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | `MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | `MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | `MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | `MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | `MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | `MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasAttachment()

> **hasAttachment**(): `this is Require<MessageContext<Bot>, "attachment">`

Defined in: contexts/index.d.ts:4829

Does this message even have an attachment?

#### Returns

`this is Require<MessageContext<Bot>, "attachment">`

***

### ~~hasAttachments()~~

> **hasAttachments**(`type?`): `boolean`

Defined in: contexts/index.d.ts:4853

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type?` | [`AttachmentType`](../type-aliases/AttachmentType.md) |

#### Returns

`boolean`

#### Deprecated

use `hasAttachmentType(type)` and `hasAttachment` instead

***

### hasAttachmentType()

> **hasAttachmentType**<`T`>(`type`): `this is RequireValue<MessageContext<Bot>, "attachment", AttachmentsMapping[T]>`

Defined in: contexts/index.d.ts:4827

Does this message have an attachment with a specific type `type`?

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`AttachmentType`](../type-aliases/AttachmentType.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | `T` |

#### Returns

`this is RequireValue<MessageContext<Bot>, "attachment", AttachmentsMapping[T]>`

***

### hasAuthorSignature()

> **hasAuthorSignature**(): `this is Require<MessageContext<Bot>, "authorSignature">`

Defined in: contexts/index.d.ts:4818

Checks if the message has `author_signature` property

#### Returns

`this is Require<MessageContext<Bot>, "authorSignature">`

***

### hasCaption()

> **hasCaption**(): `this is Require<MessageContext<Bot>, "caption">`

Defined in: contexts/index.d.ts:4805

Checks if the message has `caption` property

#### Returns

`this is Require<MessageContext<Bot>, "caption">`

***

### hasCaptionEntities()

> **hasCaptionEntities**(`type?`): `this is Require<MessageContext<Bot>, "captionEntities">`

Defined in: contexts/index.d.ts:4822

Checks if there are any caption entities (with specified type)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type?` | [`TelegramMessageEntityType`](../../../../gramio/type-aliases/TelegramMessageEntityType.md) | [`EntityType`](../enumerations/EntityType.md) |

#### Returns

`this is Require<MessageContext<Bot>, "captionEntities">`

***

### hasDice()

> **hasDice**(): `this is Require<MessageContext<Bot>, "dice">`

Defined in: contexts/index.d.ts:4807

Checks if the message has `dice` property

#### Returns

`this is Require<MessageContext<Bot>, "dice">`

***

### hasEntities()

> **hasEntities**(`type?`): `this is Require<MessageContext<Bot>, "entities">`

Defined in: contexts/index.d.ts:4820

Checks if there are any entities (with specified type)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type?` | [`TelegramMessageEntityType`](../../../../gramio/type-aliases/TelegramMessageEntityType.md) | [`EntityType`](../enumerations/EntityType.md) |

#### Returns

`this is Require<MessageContext<Bot>, "entities">`

***

### hasForwardOrigin()

> **hasForwardOrigin**(): `this is Require<MessageContext<Bot>, "forwardOrigin">`

Defined in: contexts/index.d.ts:4841

Does this message have a forward origin?

#### Returns

`this is Require<MessageContext<Bot>, "forwardOrigin">`

***

### hasFrom()

> **hasFrom**(): this is Require\<MessageContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<MessageContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasLinkPreviewOptions()

> **hasLinkPreviewOptions**(): `this is Require<MessageContext<Bot>, "linkPreviewOptions">`

Defined in: contexts/index.d.ts:4845

Does this message have link preview options?

#### Returns

`this is Require<MessageContext<Bot>, "linkPreviewOptions">`

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasQuote()

> **hasQuote**(): `this is Require<MessageContext<Bot>, "quote">`

Defined in: contexts/index.d.ts:4843

Does this message have a quote?

#### Returns

`this is Require<MessageContext<Bot>, "quote">`

***

### hasReplyInfo()

> **hasReplyInfo**(): `this is Require<MessageContext<Bot>, "externalReply">`

Defined in: contexts/index.d.ts:4847

Does this message have external reply info?

#### Returns

`this is Require<MessageContext<Bot>, "externalReply">`

***

### hasReplyMessage()

> **hasReplyMessage**(): `this is Require<MessageContext<Bot>, "replyMessage">`

Defined in: contexts/index.d.ts:4849

Does this message have reply message?

#### Returns

`this is Require<MessageContext<Bot>, "replyMessage">`

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<MessageContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<MessageContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### hasStartPayload()

> **hasStartPayload**(): `this is Require<MessageContext<Bot>, "startPayload">`

Defined in: contexts/index.d.ts:4816

Does this message have start payload?

#### Returns

`this is Require<MessageContext<Bot>, "startPayload">`

***

### hasText()

> **hasText**(): `this is Require<MessageContext<Bot>, "text">`

Defined in: contexts/index.d.ts:4797

Checks if the message has `text` property

#### Returns

`this is Require<MessageContext<Bot>, "text">`

***

### hasViaBot()

> **hasViaBot**(): `this is Require<MessageContext<Bot>, "viaBot">`

Defined in: contexts/index.d.ts:4851

Checks if the sent message has `via_bot` property

#### Returns

`this is Require<MessageContext<Bot>, "viaBot">`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<MessageContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<MessageContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isEvent()

> **isEvent**(): `boolean`

Defined in: contexts/index.d.ts:4833

Is this message an event?

#### Returns

`boolean`

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGiveaway()

> **isGiveaway**(): `this is Require<MessageContext<Bot>, "giveaway">`

Defined in: contexts/index.d.ts:4831

Is this message a giveaway

#### Returns

`this is Require<MessageContext<Bot>, "giveaway">`

***

### isGroup()

> **isGroup**(): `this is RequireValue<MessageContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<MessageContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<MessageContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<MessageContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isServiceMessage()

> **isServiceMessage**(): `boolean`

Defined in: contexts/index.d.ts:4837

Is this message a service one?

#### Returns

`boolean`

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<MessageContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<MessageContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:4839

Is this message in topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<`MessageContext`<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<`MessageContext`<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<`MessageContext`<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<`MessageContext`<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<`MessageContext`<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<`MessageContext`<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<`MessageContext`<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<`MessageContext`<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<`MessageContext`<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<`MessageContext`<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<`MessageContext`<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<`MessageContext`<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<`MessageContext`<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<`MessageContext`<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<`MessageContext`<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<`MessageContext`<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<`MessageContext`<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<`MessageContext`<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | `MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | `MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | `MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | `MessageContext`<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<`MessageContext`<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<`MessageContext`<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/MessageEntity.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageEntity

# Class: MessageEntity

Defined in: contexts/index.d.ts:536

This object represents one special entity in a text message.
For example, hashtags, usernames, URLs, etc.

## Constructors

### Constructor

> **new MessageEntity**(`payload`): `MessageEntity`

Defined in: contexts/index.d.ts:538

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramMessageEntity`](../../../../gramio/interfaces/TelegramMessageEntity.md) |

#### Returns

`MessageEntity`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramMessageEntity`](../../../../gramio/interfaces/TelegramMessageEntity.md) | contexts/index.d.ts:537 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:540

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### customEmojiId

#### Get Signature

> **get** **customEmojiId**(): `string`

Defined in: contexts/index.d.ts:571

For `custom_emoji` only, unique identifier of the custom emoji.

Use `getCustomEmojiStickers` to get full information about the sticker

##### Returns

`string`

***

### dateTimeFormat

#### Get Signature

> **get** **dateTimeFormat**(): `string`

Defined in: contexts/index.d.ts:575

For `date_time` only, the string that defines the formatting of the date and time

##### Returns

`string`

***

### language

#### Get Signature

> **get** **language**(): `string`

Defined in: contexts/index.d.ts:565

For `pre` only, the programming language of the entity text

##### Returns

`string`

***

### length

#### Get Signature

> **get** **length**(): `number`

Defined in: contexts/index.d.ts:557

Length of the entity in UTF-16 code units

##### Returns

`number`

***

### offset

#### Get Signature

> **get** **offset**(): `number`

Defined in: contexts/index.d.ts:555

Offset in UTF-16 code units to the start of the entity

##### Returns

`number`

***

### type

#### Get Signature

> **get** **type**(): [`TelegramMessageEntityType`](../../../../gramio/type-aliases/TelegramMessageEntityType.md)

Defined in: contexts/index.d.ts:553

Type of the entity.

Can be `mention` (`@username`), `hashtag` (`#hashtag`), `cashtag`
(`$USD`), `bot_command` (`/start@jobs_bot`), `url`
(`https://telegram.org`), `email` (`do-not-reply@telegram.org`),
`phone_number` (`+1-212-555-0123`), `bold` (**bold text**), `italic`
(*italic text*), `underline` (underlined text), `strikethrough`
(~~strikethrough text~~), “spoiler” (spoiler message), `code` (`monowidth string`),
`pre` (`monowidth block`), `text_link` (for clickable text URLs), `text_mention`
(for users without usernames)

##### Returns

[`TelegramMessageEntityType`](../../../../gramio/type-aliases/TelegramMessageEntityType.md)

***

### unixTime

#### Get Signature

> **get** **unixTime**(): `number`

Defined in: contexts/index.d.ts:573

For `date_time` only, the Unix time associated with the entity

##### Returns

`number`

***

### url

#### Get Signature

> **get** **url**(): `string`

Defined in: contexts/index.d.ts:561

For `text_link` only, url that will be opened after user taps on the text

##### Returns

`string`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

Defined in: contexts/index.d.ts:563

For `text_mention` only, the mentioned user

##### Returns

[`User`](User.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/MessageId.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageId

# Class: MessageId

Defined in: contexts/index.d.ts:4246

This object represents a unique message identifier.

## Constructors

### Constructor

> **new MessageId**(`payload`): `MessageId`

Defined in: contexts/index.d.ts:4248

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramMessageId`](../../../../gramio/interfaces/TelegramMessageId.md) |

#### Returns

`MessageId`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramMessageId`](../../../../gramio/interfaces/TelegramMessageId.md) | contexts/index.d.ts:4247 |

## Accessors

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4250

Unique message identifier

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/MessageOriginChannel.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageOriginChannel

# Class: MessageOriginChannel

Defined in: contexts/index.d.ts:1731

The message was originally sent to a channel chat.

## Extends

* `MessageOrigin`

## Constructors

### Constructor

> **new MessageOriginChannel**(`payload`): `MessageOriginChannel`

Defined in: contexts/index.d.ts:1733

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramMessageOriginChannel`](../../../../gramio/interfaces/TelegramMessageOriginChannel.md) |

#### Returns

`MessageOriginChannel`

#### Overrides

`MessageOrigin.constructor`

## Properties

| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
|  `payload` | [`TelegramMessageOriginChannel`](../../../../gramio/interfaces/TelegramMessageOriginChannel.md) | `MessageOrigin.payload` | contexts/index.d.ts:1732 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1725

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

`MessageOrigin.[toStringTag]`

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:1743

Signature of the original post author

##### Returns

`string`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:1739

Channel chat to which the message was originally sent

##### Returns

[`Chat`](Chat.md)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:1737

Date the message was sent originally in Unix time

##### Returns

`number`

***

### messageId

#### Get Signature

> **get** **messageId**(): `number`

Defined in: contexts/index.d.ts:1741

Unique message identifier inside the chat

##### Returns

`number`

***

### type

#### Get Signature

> **get** **type**(): `"channel"`

Defined in: contexts/index.d.ts:1735

Type of the message origin, always `channel`

##### Returns

`"channel"`

## Methods

### is()

> **is**<`T`>(`type`): `this is MessageOriginMapping[T]`

Defined in: contexts/index.d.ts:1727

Is this message origin a certain one?

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `"chat"` | `"channel"` | `"user"` | `"hidden_user"` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | `T` |

#### Returns

`this is MessageOriginMapping[T]`

#### Inherited from

`MessageOrigin.is`

---

---
url: 'https://gramio.dev/api/contexts/classes/MessageOriginChat.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageOriginChat

# Class: MessageOriginChat

Defined in: contexts/index.d.ts:1678

The message was originally sent on behalf of a chat to a group chat.

## Extends

* `MessageOrigin`

## Constructors

### Constructor

> **new MessageOriginChat**(`payload`): `MessageOriginChat`

Defined in: contexts/index.d.ts:1680

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramMessageOriginChat`](../../../../gramio/interfaces/TelegramMessageOriginChat.md) |

#### Returns

`MessageOriginChat`

#### Overrides

`MessageOrigin.constructor`

## Properties

| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
|  `payload` | [`TelegramMessageOriginChat`](../../../../gramio/interfaces/TelegramMessageOriginChat.md) | `MessageOrigin.payload` | contexts/index.d.ts:1679 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1725

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

`MessageOrigin.[toStringTag]`

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:1688

For messages originally sent by an anonymous chat administrator, original message author signature

##### Returns

`string`

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:1684

Date the message was sent originally in Unix time

##### Returns

`number`

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:1686

Chat that sent the message originally

##### Returns

[`Chat`](Chat.md)

***

### type

#### Get Signature

> **get** **type**(): `"chat"`

Defined in: contexts/index.d.ts:1682

Type of the message origin, always `chat`

##### Returns

`"chat"`

## Methods

### is()

> **is**<`T`>(`type`): `this is MessageOriginMapping[T]`

Defined in: contexts/index.d.ts:1727

Is this message origin a certain one?

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `"chat"` | `"channel"` | `"user"` | `"hidden_user"` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | `T` |

#### Returns

`this is MessageOriginMapping[T]`

#### Inherited from

`MessageOrigin.is`

---

---
url: 'https://gramio.dev/api/contexts/classes/MessageOriginHiddenUser.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageOriginHiddenUser

# Class: MessageOriginHiddenUser

Defined in: contexts/index.d.ts:1692

The message was originally sent by an unknown user.

## Extends

* `MessageOrigin`

## Constructors

### Constructor

> **new MessageOriginHiddenUser**(`payload`): `MessageOriginHiddenUser`

Defined in: contexts/index.d.ts:1694

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramMessageOriginHiddenUser`](../../../../gramio/interfaces/TelegramMessageOriginHiddenUser.md) |

#### Returns

`MessageOriginHiddenUser`

#### Overrides

`MessageOrigin.constructor`

## Properties

| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
|  `payload` | [`TelegramMessageOriginHiddenUser`](../../../../gramio/interfaces/TelegramMessageOriginHiddenUser.md) | `MessageOrigin.payload` | contexts/index.d.ts:1693 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1725

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

`MessageOrigin.[toStringTag]`

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:1698

Date the message was sent originally in Unix time

##### Returns

`number`

***

### senderUserName

#### Get Signature

> **get** **senderUserName**(): `string`

Defined in: contexts/index.d.ts:1700

Name of the user that sent the message originally

##### Returns

`string`

***

### type

#### Get Signature

> **get** **type**(): `"hidden_user"`

Defined in: contexts/index.d.ts:1696

Type of the message origin, always `hidden_user`

##### Returns

`"hidden_user"`

## Methods

### is()

> **is**<`T`>(`type`): `this is MessageOriginMapping[T]`

Defined in: contexts/index.d.ts:1727

Is this message origin a certain one?

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `"chat"` | `"channel"` | `"user"` | `"hidden_user"` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | `T` |

#### Returns

`this is MessageOriginMapping[T]`

#### Inherited from

`MessageOrigin.is`

---

---
url: 'https://gramio.dev/api/contexts/classes/MessageOriginUser.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageOriginUser

# Class: MessageOriginUser

Defined in: contexts/index.d.ts:1704

The message was originally sent by a known user.

## Extends

* `MessageOrigin`

## Constructors

### Constructor

> **new MessageOriginUser**(`payload`): `MessageOriginUser`

Defined in: contexts/index.d.ts:1706

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramMessageOriginUser`](../../../../gramio/interfaces/TelegramMessageOriginUser.md) |

#### Returns

`MessageOriginUser`

#### Overrides

`MessageOrigin.constructor`

## Properties

| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
|  `payload` | [`TelegramMessageOriginUser`](../../../../gramio/interfaces/TelegramMessageOriginUser.md) | `MessageOrigin.payload` | contexts/index.d.ts:1705 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1725

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

`MessageOrigin.[toStringTag]`

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:1710

Date the message was sent originally in Unix time

##### Returns

`number`

***

### senderUser

#### Get Signature

> **get** **senderUser**(): [`User`](User.md)

Defined in: contexts/index.d.ts:1712

User that sent the message originally

##### Returns

[`User`](User.md)

***

### type

#### Get Signature

> **get** **type**(): `"user"`

Defined in: contexts/index.d.ts:1708

Type of the message origin, always `user`

##### Returns

`"user"`

## Methods

### is()

> **is**<`T`>(`type`): `this is MessageOriginMapping[T]`

Defined in: contexts/index.d.ts:1727

Is this message origin a certain one?

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `"chat"` | `"channel"` | `"user"` | `"hidden_user"` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | `T` |

#### Returns

`this is MessageOriginMapping[T]`

#### Inherited from

`MessageOrigin.is`

---

---
url: 'https://gramio.dev/api/contexts/classes/MessageReactionContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageReactionContext

# Class: MessageReactionContext\<Bot>

Defined in: contexts/index.d.ts:6042

This object represents a change of a reaction on a message performed by a user.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`MessageReactionContext`<`Bot`>>.[`MessageReactionUpdated`](MessageReactionUpdated.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `MessageReactionContext`<`Bot`>, `MessageReactionContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new MessageReactionContext**<`Bot`>(`options`): `MessageReactionContext`<`Bot`>

Defined in: contexts/index.d.ts:6045

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `MessageReactionContextOptions`<`Bot`> |

#### Returns

`MessageReactionContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new MessageReactionContext**(...`args`): `MessageReactionContext`

Defined in: contexts/index.d.ts:6042

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`MessageReactionContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | [`TelegramMessageReactionUpdated`](../../../../gramio/interfaces/TelegramMessageReactionUpdated.md) | The raw data that is used for this Context | [`MessageReactionUpdated`](MessageReactionUpdated.md).[`payload`](MessageReactionUpdated.md#payload) | contexts/index.d.ts:6044 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### actorChat

#### Get Signature

> **get** **actorChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4336

The chat on behalf of which the reaction was changed, if the user is anonymous

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`MessageReactionUpdated`](MessageReactionUpdated.md).[`actorChat`](MessageReactionUpdated.md#actorchat)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4330

The chat containing the message the user reacted to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`MessageReactionUpdated`](MessageReactionUpdated.md).[`chat`](MessageReactionUpdated.md#chat)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4859

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:4338

Date of the change in Unix time

##### Returns

`number`

#### Inherited from

[`MessageReactionUpdated`](MessageReactionUpdated.md).[`date`](MessageReactionUpdated.md#date)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4332

Unique identifier of the message inside the chat

##### Returns

`number`

#### Inherited from

[`MessageReactionUpdated`](MessageReactionUpdated.md).[`id`](MessageReactionUpdated.md#id)

***

### newReactions

#### Get Signature

> **get** **newReactions**(): [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)\[]

Defined in: contexts/index.d.ts:4342

New list of reaction types that have been set by the user

##### Returns

[`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)\[]

#### Inherited from

[`MessageReactionUpdated`](MessageReactionUpdated.md).[`newReactions`](MessageReactionUpdated.md#newreactions)

***

### oldReactions

#### Get Signature

> **get** **oldReactions**(): [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)\[]

Defined in: contexts/index.d.ts:4340

Previous list of reaction types that were set by the user

##### Returns

[`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)\[]

#### Inherited from

[`MessageReactionUpdated`](MessageReactionUpdated.md).[`oldReactions`](MessageReactionUpdated.md#oldreactions)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4861

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`senderId`](SendMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4334

The user that changed the reaction, if the user isn't anonymous

##### Returns

[`User`](User.md)

#### Inherited from

[`MessageReactionUpdated`](MessageReactionUpdated.md).[`user`](MessageReactionUpdated.md#user)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `MessageReactionContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `MessageReactionContextOptions` |

#### Returns

`MessageReactionContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasActorChat()

> **hasActorChat**(): `this is Require<MessageReactionContext<Bot>, "actorChat">`

Defined in: contexts/index.d.ts:6049

Checks if context has the `actorChat` property

#### Returns

`this is Require<MessageReactionContext<Bot>, "actorChat">`

***

### hasUser()

> **hasUser**(): `this is Require<MessageReactionContext<Bot>, "user">`

Defined in: contexts/index.d.ts:6047

Checks if context has the `user` property

#### Returns

`this is Require<MessageReactionContext<Bot>, "user">`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/MessageReactionCountContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageReactionCountContext

# Class: MessageReactionCountContext\<Bot>

Defined in: contexts/index.d.ts:6027

This object represents reaction changes on a message with anonymous reactions.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`MessageReactionCountContext`<`Bot`>>.[`MessageReactionCountUpdated`](MessageReactionCountUpdated.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `MessageReactionCountContext`<`Bot`>, `MessageReactionCountContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new MessageReactionCountContext**<`Bot`>(`options`): `MessageReactionCountContext`<`Bot`>

Defined in: contexts/index.d.ts:6030

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `MessageReactionCountContextOptions`<`Bot`> |

#### Returns

`MessageReactionCountContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new MessageReactionCountContext**(...`args`): `MessageReactionCountContext`

Defined in: contexts/index.d.ts:6027

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`MessageReactionCountContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | [`TelegramMessageReactionCountUpdated`](../../../../gramio/interfaces/TelegramMessageReactionCountUpdated.md) | The raw data that is used for this Context | [`MessageReactionCountUpdated`](MessageReactionCountUpdated.md).[`payload`](MessageReactionCountUpdated.md#payload) | contexts/index.d.ts:6029 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4314

The chat containing the message the user reacted to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`MessageReactionCountUpdated`](MessageReactionCountUpdated.md).[`chat`](MessageReactionCountUpdated.md#chat)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4859

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:4318

Date of the change in Unix time

##### Returns

`number`

#### Inherited from

[`MessageReactionCountUpdated`](MessageReactionCountUpdated.md).[`date`](MessageReactionCountUpdated.md#date)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4316

Unique identifier of the message inside the chat

##### Returns

`number`

#### Inherited from

[`MessageReactionCountUpdated`](MessageReactionCountUpdated.md).[`id`](MessageReactionCountUpdated.md#id)

***

### reactions

#### Get Signature

> **get** **reactions**(): `ReactionType`\[]

Defined in: contexts/index.d.ts:4320

List of reactions that are present on the message

##### Returns

`ReactionType`\[]

#### Inherited from

[`MessageReactionCountUpdated`](MessageReactionCountUpdated.md).[`reactions`](MessageReactionCountUpdated.md#reactions)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4861

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`senderId`](SendMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `MessageReactionCountContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `MessageReactionCountContextOptions` |

#### Returns

`MessageReactionCountContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/MessageReactionCountUpdated.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageReactionCountUpdated

# Class: MessageReactionCountUpdated

Defined in: contexts/index.d.ts:4308

This object represents reaction changes on a message with anonymous reactions.

## Extended by

* [`MessageReactionCountContext`](MessageReactionCountContext.md)

## Constructors

### Constructor

> **new MessageReactionCountUpdated**(`payload`): `MessageReactionCountUpdated`

Defined in: contexts/index.d.ts:4310

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramMessageReactionCountUpdated`](../../../../gramio/interfaces/TelegramMessageReactionCountUpdated.md) |

#### Returns

`MessageReactionCountUpdated`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramMessageReactionCountUpdated`](../../../../gramio/interfaces/TelegramMessageReactionCountUpdated.md) | contexts/index.d.ts:4309 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4312

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4314

The chat containing the message the user reacted to

##### Returns

[`Chat`](Chat.md)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:4318

Date of the change in Unix time

##### Returns

`number`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4316

Unique identifier of the message inside the chat

##### Returns

`number`

***

### reactions

#### Get Signature

> **get** **reactions**(): `ReactionType`\[]

Defined in: contexts/index.d.ts:4320

List of reactions that are present on the message

##### Returns

`ReactionType`\[]

---

---
url: 'https://gramio.dev/api/contexts/classes/MessageReactionUpdated.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageReactionUpdated

# Class: MessageReactionUpdated

Defined in: contexts/index.d.ts:4324

This object represents a change of a reaction on a message performed by a user.

## Extended by

* [`MessageReactionContext`](MessageReactionContext.md)

## Constructors

### Constructor

> **new MessageReactionUpdated**(`payload`): `MessageReactionUpdated`

Defined in: contexts/index.d.ts:4326

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramMessageReactionUpdated`](../../../../gramio/interfaces/TelegramMessageReactionUpdated.md) |

#### Returns

`MessageReactionUpdated`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramMessageReactionUpdated`](../../../../gramio/interfaces/TelegramMessageReactionUpdated.md) | contexts/index.d.ts:4325 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4328

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### actorChat

#### Get Signature

> **get** **actorChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4336

The chat on behalf of which the reaction was changed, if the user is anonymous

##### Returns

[`Chat`](Chat.md)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4330

The chat containing the message the user reacted to

##### Returns

[`Chat`](Chat.md)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:4338

Date of the change in Unix time

##### Returns

`number`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4332

Unique identifier of the message inside the chat

##### Returns

`number`

***

### newReactions

#### Get Signature

> **get** **newReactions**(): [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)\[]

Defined in: contexts/index.d.ts:4342

New list of reaction types that have been set by the user

##### Returns

[`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)\[]

***

### oldReactions

#### Get Signature

> **get** **oldReactions**(): [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)\[]

Defined in: contexts/index.d.ts:4340

Previous list of reaction types that were set by the user

##### Returns

[`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)\[]

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4334

The user that changed the reaction, if the user isn't anonymous

##### Returns

[`User`](User.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/MigrateFromChatIdContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MigrateFromChatIdContext

# Class: MigrateFromChatIdContext\<Bot>

Defined in: contexts/index.d.ts:6061

The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`MigrateFromChatIdContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `MigrateFromChatIdContext`<`Bot`>, `MigrateFromChatIdContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new MigrateFromChatIdContext**<`Bot`>(`options`): `MigrateFromChatIdContext`<`Bot`>

Defined in: contexts/index.d.ts:6064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `MigrateFromChatIdContextOptions`<`Bot`> |

#### Returns

`MigrateFromChatIdContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new MigrateFromChatIdContext**(...`args`): `MigrateFromChatIdContext`

Defined in: contexts/index.d.ts:6061

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`MigrateFromChatIdContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6063 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventId

#### Get Signature

> **get** **eventId**(): `number`

Defined in: contexts/index.d.ts:6066

Chat ID

##### Returns

`number`

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `MigrateFromChatIdContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `MigrateFromChatIdContextOptions` |

#### Returns

`MigrateFromChatIdContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<MigrateFromChatIdContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<MigrateFromChatIdContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<MigrateFromChatIdContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<MigrateFromChatIdContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<MigrateFromChatIdContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<MigrateFromChatIdContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<MigrateFromChatIdContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<MigrateFromChatIdContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<MigrateFromChatIdContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<MigrateFromChatIdContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<MigrateFromChatIdContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<MigrateFromChatIdContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/MigrateToChatIdContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MigrateToChatIdContext

# Class: MigrateToChatIdContext\<Bot>

Defined in: contexts/index.d.ts:6078

The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`MigrateToChatIdContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `MigrateToChatIdContext`<`Bot`>, `MigrateToChatIdContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new MigrateToChatIdContext**<`Bot`>(`options`): `MigrateToChatIdContext`<`Bot`>

Defined in: contexts/index.d.ts:6081

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `MigrateToChatIdContextOptions`<`Bot`> |

#### Returns

`MigrateToChatIdContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new MigrateToChatIdContext**(...`args`): `MigrateToChatIdContext`

Defined in: contexts/index.d.ts:6078

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`MigrateToChatIdContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6080 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventId

#### Get Signature

> **get** **eventId**(): `number`

Defined in: contexts/index.d.ts:6083

Chat ID

##### Returns

`number`

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `MigrateToChatIdContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `MigrateToChatIdContextOptions` |

#### Returns

`MigrateToChatIdContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<MigrateToChatIdContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<MigrateToChatIdContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<MigrateToChatIdContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<MigrateToChatIdContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<MigrateToChatIdContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<MigrateToChatIdContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<MigrateToChatIdContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<MigrateToChatIdContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<MigrateToChatIdContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<MigrateToChatIdContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<MigrateToChatIdContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<MigrateToChatIdContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/NewChatMembersContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / NewChatMembersContext

# Class: NewChatMembersContext\<Bot>

Defined in: contexts/index.d.ts:6095

New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`NewChatMembersContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `NewChatMembersContext`<`Bot`>, `NewChatMembersContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new NewChatMembersContext**<`Bot`>(`options`): `NewChatMembersContext`<`Bot`>

Defined in: contexts/index.d.ts:6098

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `NewChatMembersContextOptions`<`Bot`> |

#### Returns

`NewChatMembersContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new NewChatMembersContext**(...`args`): `NewChatMembersContext`

Defined in: contexts/index.d.ts:6095

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`NewChatMembersContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6097 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventMembers

#### Get Signature

> **get** **eventMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:6100

New chat members

##### Returns

[`User`](User.md)\[]

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `NewChatMembersContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `NewChatMembersContextOptions` |

#### Returns

`NewChatMembersContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<NewChatMembersContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<NewChatMembersContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<NewChatMembersContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<NewChatMembersContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<NewChatMembersContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<NewChatMembersContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<NewChatMembersContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<NewChatMembersContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<NewChatMembersContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<NewChatMembersContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<NewChatMembersContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<NewChatMembersContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/NewChatPhotoContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / NewChatPhotoContext

# Class: NewChatPhotoContext\<Bot>

Defined in: contexts/index.d.ts:6112

A chat photo was change to this value

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`NewChatPhotoContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `NewChatPhotoContext`<`Bot`>, `NewChatPhotoContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new NewChatPhotoContext**<`Bot`>(`options`): `NewChatPhotoContext`<`Bot`>

Defined in: contexts/index.d.ts:6115

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `NewChatPhotoContextOptions`<`Bot`> |

#### Returns

`NewChatPhotoContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new NewChatPhotoContext**(...`args`): `NewChatPhotoContext`

Defined in: contexts/index.d.ts:6112

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`NewChatPhotoContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6114 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventPhoto

#### Get Signature

> **get** **eventPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:6117

New chat photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `NewChatPhotoContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `NewChatPhotoContextOptions` |

#### Returns

`NewChatPhotoContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<NewChatPhotoContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<NewChatPhotoContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<NewChatPhotoContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<NewChatPhotoContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<NewChatPhotoContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<NewChatPhotoContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<NewChatPhotoContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<NewChatPhotoContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<NewChatPhotoContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<NewChatPhotoContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<NewChatPhotoContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<NewChatPhotoContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/NewChatTitleContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / NewChatTitleContext

# Class: NewChatTitleContext\<Bot>

Defined in: contexts/index.d.ts:6129

A chat title was changed to this value

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`NewChatTitleContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `NewChatTitleContext`<`Bot`>, `NewChatTitleContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new NewChatTitleContext**<`Bot`>(`options`): `NewChatTitleContext`<`Bot`>

Defined in: contexts/index.d.ts:6132

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `NewChatTitleContextOptions`<`Bot`> |

#### Returns

`NewChatTitleContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new NewChatTitleContext**(...`args`): `NewChatTitleContext`

Defined in: contexts/index.d.ts:6129

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`NewChatTitleContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6131 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventTitle

#### Get Signature

> **get** **eventTitle**(): `string`

Defined in: contexts/index.d.ts:6134

New chat title

##### Returns

`string`

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `NewChatTitleContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `NewChatTitleContextOptions` |

#### Returns

`NewChatTitleContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<NewChatTitleContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<NewChatTitleContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<NewChatTitleContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<NewChatTitleContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<NewChatTitleContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<NewChatTitleContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<NewChatTitleContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<NewChatTitleContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<NewChatTitleContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<NewChatTitleContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<NewChatTitleContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<NewChatTitleContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/NodeMixin.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / NodeMixin

# Class: NodeMixin\<Bot>

Defined in: contexts/index.d.ts:4954

This object represents a mixin which has `id` field and can invoke `id`-dependent methods

## Extends

* [`Context`](Context.md)<`Bot`>.`NodeMixinMetadata`.[`SendMixin`](SendMixin.md)<`Bot`>

## Extended by

* [`BoostAddedContext`](BoostAddedContext.md)
* [`ChatBackgroundSetContext`](ChatBackgroundSetContext.md)
* [`ChatControlMixin`](ChatControlMixin.md)
* [`ChatMemberControlMixin`](ChatMemberControlMixin.md)
* [`ChatOwnerChangedContext`](ChatOwnerChangedContext.md)
* [`ChatOwnerLeftContext`](ChatOwnerLeftContext.md)
* [`ChatSharedContext`](ChatSharedContext.md)
* [`ChecklistTasksAddedContext`](ChecklistTasksAddedContext.md)
* [`ChecklistTasksDoneContext`](ChecklistTasksDoneContext.md)
* [`DeleteChatPhotoContext`](DeleteChatPhotoContext.md)
* [`DirectMessagePriceChangedContext`](DirectMessagePriceChangedContext.md)
* [`ForumMixin`](ForumMixin.md)
* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiftContext`](GiftContext.md)
* [`GiftUpgradeSentContext`](GiftUpgradeSentContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)
* [`GroupChatCreatedContext`](GroupChatCreatedContext.md)
* [`InvoiceContext`](InvoiceContext.md)
* [`LeftChatMemberContext`](LeftChatMemberContext.md)
* [`LocationContext`](LocationContext.md)
* [`MessageAutoDeleteTimerChangedContext`](MessageAutoDeleteTimerChangedContext.md)
* [`MessageContext`](MessageContext.md)
* [`MessageReactionContext`](MessageReactionContext.md)
* [`MessageReactionCountContext`](MessageReactionCountContext.md)
* [`MigrateFromChatIdContext`](MigrateFromChatIdContext.md)
* [`MigrateToChatIdContext`](MigrateToChatIdContext.md)
* [`NewChatMembersContext`](NewChatMembersContext.md)
* [`NewChatPhotoContext`](NewChatPhotoContext.md)
* [`NewChatTitleContext`](NewChatTitleContext.md)
* [`PaidMessagePriceChangedContext`](PaidMessagePriceChangedContext.md)
* [`PassportDataContext`](PassportDataContext.md)
* [`PinnedMessageContext`](PinnedMessageContext.md)
* [`PinsMixin`](PinsMixin.md)
* [`ProximityAlertTriggeredContext`](ProximityAlertTriggeredContext.md)
* [`RefundedPaymentContext`](RefundedPaymentContext.md)
* [`SuccessfulPaymentContext`](SuccessfulPaymentContext.md)
* [`SuggestedPostApprovalFailedContext`](SuggestedPostApprovalFailedContext.md)
* [`SuggestedPostApprovedContext`](SuggestedPostApprovedContext.md)
* [`SuggestedPostDeclinedContext`](SuggestedPostDeclinedContext.md)
* [`SuggestedPostPaidContext`](SuggestedPostPaidContext.md)
* [`SuggestedPostRefundedContext`](SuggestedPostRefundedContext.md)
* [`UniqueGiftContext`](UniqueGiftContext.md)
* [`UsersSharedContext`](UsersSharedContext.md)
* [`VideoChatEndedContext`](VideoChatEndedContext.md)
* [`VideoChatParticipantsInvitedContext`](VideoChatParticipantsInvitedContext.md)
* [`VideoChatScheduledContext`](VideoChatScheduledContext.md)
* [`VideoChatStartedContext`](VideoChatStartedContext.md)
* [`WebAppDataContext`](WebAppDataContext.md)
* [`WriteAccessAllowedContext`](WriteAccessAllowedContext.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new NodeMixin**<`Bot`>(): `NodeMixin`<`Bot`>

#### Returns

`NodeMixin`<`Bot`>

#### Inherited from

[`Context`](Context.md).[`constructor`](Context.md#constructor)

## Properties

| Property | Modifier | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4859

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4944

##### Returns

`number`

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4861

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`senderId`](SendMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/OrderInfo.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / OrderInfo

# Class: OrderInfo

Defined in: contexts/index.d.ts:2236

This object represents information about an order.

## Constructors

### Constructor

> **new OrderInfo**(`payload`): `OrderInfo`

Defined in: contexts/index.d.ts:2238

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramOrderInfo`](../../../../gramio/interfaces/TelegramOrderInfo.md) |

#### Returns

`OrderInfo`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramOrderInfo`](../../../../gramio/interfaces/TelegramOrderInfo.md) | contexts/index.d.ts:2237 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2240

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### email

#### Get Signature

> **get** **email**(): `string`

Defined in: contexts/index.d.ts:2246

User email

##### Returns

`string`

***

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: contexts/index.d.ts:2242

User name

##### Returns

`string`

***

### phoneNumber

#### Get Signature

> **get** **phoneNumber**(): `string`

Defined in: contexts/index.d.ts:2244

User's phone number

##### Returns

`string`

***

### shippingAddress

#### Get Signature

> **get** **shippingAddress**(): [`ShippingAddress`](ShippingAddress.md)

Defined in: contexts/index.d.ts:2248

User shipping address

##### Returns

[`ShippingAddress`](ShippingAddress.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/PaidMediaInfo.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PaidMediaInfo

# Class: PaidMediaInfo

Defined in: contexts/index.d.ts:1816

Describes the paid media added to a message.

[Documentation](https://core.telegram.org/bots/api/#paidmediainfo)

## Constructors

### Constructor

> **new PaidMediaInfo**(`payload`): `PaidMediaInfo`

Defined in: contexts/index.d.ts:1818

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramPaidMediaInfo`](../../../../gramio/interfaces/TelegramPaidMediaInfo.md) |

#### Returns

`PaidMediaInfo`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramPaidMediaInfo`](../../../../gramio/interfaces/TelegramPaidMediaInfo.md) | contexts/index.d.ts:1817 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1819

##### Returns

`string`

***

### paidMedia

#### Get Signature

> **get** **paidMedia**(): ([`PaidMediaPreview`](PaidMediaPreview.md) | [`PaidMediaVideo`](PaidMediaVideo.md) | [`PaidMediaPhoto`](PaidMediaPhoto.md))\[]

Defined in: contexts/index.d.ts:1827

Information about the paid media

##### Returns

([`PaidMediaPreview`](PaidMediaPreview.md) | [`PaidMediaVideo`](PaidMediaVideo.md) | [`PaidMediaPhoto`](PaidMediaPhoto.md))\[]

***

### starCount

#### Get Signature

> **get** **starCount**(): `number`

Defined in: contexts/index.d.ts:1823

The number of Telegram Stars that must be paid to buy access to the media

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/PaidMediaPhoto.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PaidMediaPhoto

# Class: PaidMediaPhoto

Defined in: contexts/index.d.ts:1751

The paid media is a photo.

[Documentation](https://core.telegram.org/bots/api/#paidmediaphoto)

## Constructors

### Constructor

> **new PaidMediaPhoto**(`payload`): `PaidMediaPhoto`

Defined in: contexts/index.d.ts:1753

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramPaidMediaPhoto`](../../../../gramio/interfaces/TelegramPaidMediaPhoto.md) |

#### Returns

`PaidMediaPhoto`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramPaidMediaPhoto`](../../../../gramio/interfaces/TelegramPaidMediaPhoto.md) | contexts/index.d.ts:1752 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1754

##### Returns

`string`

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoAttachment`](PhotoAttachment.md)

Defined in: contexts/index.d.ts:1762

The photo

##### Returns

[`PhotoAttachment`](PhotoAttachment.md)

***

### type

#### Get Signature

> **get** **type**(): `"photo"`

Defined in: contexts/index.d.ts:1758

Type of the paid media, always “photo”

##### Returns

`"photo"`

---

---
url: 'https://gramio.dev/api/contexts/classes/PaidMediaPreview.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PaidMediaPreview

# Class: PaidMediaPreview

Defined in: contexts/index.d.ts:1789

The paid media isn't available before the payment.

[Documentation](https://core.telegram.org/bots/api/#paidmediapreview)

## Constructors

### Constructor

> **new PaidMediaPreview**(`payload`): `PaidMediaPreview`

Defined in: contexts/index.d.ts:1791

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramPaidMediaPreview`](../../../../gramio/interfaces/TelegramPaidMediaPreview.md) |

#### Returns

`PaidMediaPreview`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramPaidMediaPreview`](../../../../gramio/interfaces/TelegramPaidMediaPreview.md) | contexts/index.d.ts:1790 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1792

##### Returns

`string`

***

### duration

#### Get Signature

> **get** **duration**(): `number`

Defined in: contexts/index.d.ts:1808

*Optional*. Duration of the media in seconds as defined by the sender

##### Returns

`number`

***

### height

#### Get Signature

> **get** **height**(): `number`

Defined in: contexts/index.d.ts:1804

*Optional*. Media height as defined by the sender

##### Returns

`number`

***

### type

#### Get Signature

> **get** **type**(): `"preview"`

Defined in: contexts/index.d.ts:1796

Type of the paid media, always “preview”

##### Returns

`"preview"`

***

### width

#### Get Signature

> **get** **width**(): `number`

Defined in: contexts/index.d.ts:1800

*Optional*. Media width as defined by the sender

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/PaidMediaPurchasedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PaidMediaPurchasedContext

# Class: PaidMediaPurchasedContext\<Bot>

Defined in: contexts/index.d.ts:6150

This object contains information about a paid media purchase.

[Documentation](https://core.telegram.org/bots/api#paidmediapurchased)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`PaidMediaPurchasedContext`<`Bot`>>.[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `PaidMediaPurchasedContext`<`Bot`>, `PaidMediaPurchasedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new PaidMediaPurchasedContext**<`Bot`>(`options`): `PaidMediaPurchasedContext`<`Bot`>

Defined in: contexts/index.d.ts:6153

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `PaidMediaPurchasedContextOptions`<`Bot`> |

#### Returns

`PaidMediaPurchasedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new PaidMediaPurchasedContext**(...`args`): `PaidMediaPurchasedContext`

Defined in: contexts/index.d.ts:6150

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`PaidMediaPurchasedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | [`TelegramPaidMediaPurchased`](../../../../gramio/interfaces/TelegramPaidMediaPurchased.md) | The raw data that is used for this Context | [`TargetMixin`](TargetMixin.md).[`payload`](TargetMixin.md#payload) | contexts/index.d.ts:6152 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4765

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`businessConnectionId`](TargetMixin.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4759

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chat`](TargetMixin.md#chat)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:6154

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`from`](TargetMixin.md#from)

***

### paidMediaPayload

#### Get Signature

> **get** **paidMediaPayload**(): `string`

Defined in: contexts/index.d.ts:6156

Bot-specified paid media payload

##### Returns

`string`

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:4757

*Optional*. If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderBoostCount`](TargetMixin.md#senderboostcount)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4753

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderChat`](TargetMixin.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### clone()

> **clone**(`options?`): `PaidMediaPurchasedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `PaidMediaPurchasedContextOptions` |

#### Returns

`PaidMediaPurchasedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<PaidMediaPurchasedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<PaidMediaPurchasedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<PaidMediaPurchasedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<PaidMediaPurchasedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isChannel()

> **isChannel**(): `this is RequireValue<PaidMediaPurchasedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<PaidMediaPurchasedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isGroup()

> **isGroup**(): `this is RequireValue<PaidMediaPurchasedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<PaidMediaPurchasedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPM()

> **isPM**(): `this is RequireValue<PaidMediaPurchasedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<PaidMediaPurchasedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<PaidMediaPurchasedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<PaidMediaPurchasedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/PaidMediaVideo.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PaidMediaVideo

# Class: PaidMediaVideo

Defined in: contexts/index.d.ts:1770

The paid media is a video.

[Documentation](https://core.telegram.org/bots/api/#paidmediavideo)

## Constructors

### Constructor

> **new PaidMediaVideo**(`payload`): `PaidMediaVideo`

Defined in: contexts/index.d.ts:1772

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramPaidMediaVideo`](../../../../gramio/interfaces/TelegramPaidMediaVideo.md) |

#### Returns

`PaidMediaVideo`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramPaidMediaVideo`](../../../../gramio/interfaces/TelegramPaidMediaVideo.md) | contexts/index.d.ts:1771 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1773

##### Returns

`string`

***

### type

#### Get Signature

> **get** **type**(): `"video"`

Defined in: contexts/index.d.ts:1777

Type of the paid media, always “video”

##### Returns

`"video"`

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:1781

The video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/PaidMessagePriceChangedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PaidMessagePriceChangedContext

# Class: PaidMessagePriceChangedContext\<Bot>

Defined in: contexts/index.d.ts:6172

Describes a service message about a change in the price of paid messages within a chat.

[Documentation](https://core.telegram.org/bots/api/#paidmessagepricechanged)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`PaidMessagePriceChangedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `PaidMessagePriceChangedContext`<`Bot`>, `PaidMessagePriceChangedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new PaidMessagePriceChangedContext**<`Bot`>(`options`): `PaidMessagePriceChangedContext`<`Bot`>

Defined in: contexts/index.d.ts:6176

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `PaidMessagePriceChangedContextOptions`<`Bot`> |

#### Returns

`PaidMessagePriceChangedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new PaidMessagePriceChangedContext**(...`args`): `PaidMessagePriceChangedContext`

Defined in: contexts/index.d.ts:6172

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`PaidMessagePriceChangedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6174 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidMessageStarCount

#### Get Signature

> **get** **paidMessageStarCount**(): `number`

Defined in: contexts/index.d.ts:6180

The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message

##### Returns

`number`

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `PaidMessagePriceChangedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `PaidMessagePriceChangedContextOptions` |

#### Returns

`PaidMessagePriceChangedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<PaidMessagePriceChangedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<PaidMessagePriceChangedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<PaidMessagePriceChangedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<PaidMessagePriceChangedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<PaidMessagePriceChangedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<PaidMessagePriceChangedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<PaidMessagePriceChangedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<PaidMessagePriceChangedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<PaidMessagePriceChangedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<PaidMessagePriceChangedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<PaidMessagePriceChangedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<PaidMessagePriceChangedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/PassportData.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PassportData

# Class: PassportData

Defined in: contexts/index.d.ts:2186

Contains information about Telegram Passport data shared with the bot by the
user.

## Constructors

### Constructor

> **new PassportData**(`payload`): `PassportData`

Defined in: contexts/index.d.ts:2188

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramPassportData`](../../../../gramio/interfaces/TelegramPassportData.md) |

#### Returns

`PassportData`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramPassportData`](../../../../gramio/interfaces/TelegramPassportData.md) | contexts/index.d.ts:2187 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2190

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### credentials

#### Get Signature

> **get** **credentials**(): [`EncryptedCredentials`](EncryptedCredentials.md)

Defined in: contexts/index.d.ts:2197

Encrypted credentials required to decrypt the data

##### Returns

[`EncryptedCredentials`](EncryptedCredentials.md)

***

### data

#### Get Signature

> **get** **data**(): [`EncryptedPassportElement`](EncryptedPassportElement.md)\[]

Defined in: contexts/index.d.ts:2195

Array with information about documents and other Telegram Passport
elements that was shared with the bot

##### Returns

[`EncryptedPassportElement`](EncryptedPassportElement.md)\[]

---

---
url: 'https://gramio.dev/api/contexts/classes/PassportDataContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PassportDataContext

# Class: PassportDataContext\<Bot>

Defined in: contexts/index.d.ts:6196

Describes Telegram Passport data shared with the bot by the user.

[Documentation](https://core.telegram.org/bots/api/#passportdata)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`PassportDataContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `PassportDataContext`<`Bot`>, `PassportDataContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new PassportDataContext**<`Bot`>(`options`): `PassportDataContext`<`Bot`>

Defined in: contexts/index.d.ts:6199

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `PassportDataContextOptions`<`Bot`> |

#### Returns

`PassportDataContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new PassportDataContext**(...`args`): `PassportDataContext`

Defined in: contexts/index.d.ts:6196

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`PassportDataContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6198 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:6201

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `PassportDataContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `PassportDataContextOptions` |

#### Returns

`PassportDataContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<PassportDataContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<PassportDataContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<PassportDataContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<PassportDataContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<PassportDataContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<PassportDataContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<PassportDataContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<PassportDataContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<PassportDataContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<PassportDataContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<PassportDataContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<PassportDataContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/PassportFile.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PassportFile

# Class: PassportFile

Defined in: contexts/index.d.ts:2092

This object represents a file uploaded to Telegram Passport.
Currently all Telegram Passport files are in JPEG format when decrypted and
don't exceed 10MB.

## Constructors

### Constructor

> **new PassportFile**(`payload`): `PassportFile`

Defined in: contexts/index.d.ts:2094

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramPassportFile`](../../../../gramio/interfaces/TelegramPassportFile.md) |

#### Returns

`PassportFile`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramPassportFile`](../../../../gramio/interfaces/TelegramPassportFile.md) | contexts/index.d.ts:2093 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2096

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### fileDate

#### Get Signature

> **get** **fileDate**(): `number`

Defined in: contexts/index.d.ts:2109

Unix time when the file was uploaded

##### Returns

`number`

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

Defined in: contexts/index.d.ts:2100

Identifier for this file, which can be used to download or reuse the file

##### Returns

`string`

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

Defined in: contexts/index.d.ts:2107

File size

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

Defined in: contexts/index.d.ts:2105

Unique identifier for this file, which is supposed to be the same over
time and for different bots. Can't be used to download or reuse the file.

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/PhotoAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PhotoAttachment

# Class: PhotoAttachment

Defined in: contexts/index.d.ts:460

This object represents a photo file with it's sizes

## Extends

* [`Attachment`](Attachment.md)

## Constructors

### Constructor

> **new PhotoAttachment**(`payload`): `PhotoAttachment`

Defined in: contexts/index.d.ts:464

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`PhotoSize`](PhotoSize.md)\[] |

#### Returns

`PhotoAttachment`

#### Overrides

[`Attachment`](Attachment.md).[`constructor`](Attachment.md#constructor)

## Properties

| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
|  `attachmentType` | [`AttachmentType`](../type-aliases/AttachmentType.md) | [`Attachment`](Attachment.md).[`attachmentType`](Attachment.md#attachmenttype) | contexts/index.d.ts:463 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:314

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Attachment`](Attachment.md).[`[toStringTag]`](Attachment.md#tostringtag)

***

### bigSize

#### Get Signature

> **get** **bigSize**(): [`PhotoSize`](PhotoSize.md)

Defined in: contexts/index.d.ts:468

Biggest size of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)

***

### mediumSize

#### Get Signature

> **get** **mediumSize**(): [`PhotoSize`](PhotoSize.md)

Defined in: contexts/index.d.ts:470

Medium size of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)

***

### sizes

#### Get Signature

> **get** **sizes**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:466

Photo sizes

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

***

### smallSize

#### Get Signature

> **get** **smallSize**(): [`PhotoSize`](PhotoSize.md)

Defined in: contexts/index.d.ts:472

Smallest size of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/PhotoSize.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PhotoSize

# Class: PhotoSize

Defined in: contexts/index.d.ts:37

This object represents one size of a photo or a file / sticker thumbnail

## Constructors

### Constructor

> **new PhotoSize**(`payload`): `PhotoSize`

Defined in: contexts/index.d.ts:39

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramPhotoSize`](../../../../gramio/interfaces/TelegramPhotoSize.md) |

#### Returns

`PhotoSize`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramPhotoSize`](../../../../gramio/interfaces/TelegramPhotoSize.md) | contexts/index.d.ts:38 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:41

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

Defined in: contexts/index.d.ts:45

Identifier for this file, which can be used to download or reuse the file

##### Returns

`string`

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

Defined in: contexts/index.d.ts:56

File size

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

Defined in: contexts/index.d.ts:50

Unique identifier for this file, which is supposed to be the same over
time and for different bots. Can't be used to download or reuse the file.

##### Returns

`string`

***

### height

#### Get Signature

> **get** **height**(): `number`

Defined in: contexts/index.d.ts:54

Photo height

##### Returns

`number`

***

### width

#### Get Signature

> **get** **width**(): `number`

Defined in: contexts/index.d.ts:52

Photo width

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/PinnedMessageContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PinnedMessageContext

# Class: PinnedMessageContext\<Bot>

Defined in: contexts/index.d.ts:6213

Specified message was pinned. Note that the Message object in this field will not contain further *reply\_to\_message* fields even if it itself is a reply.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`PinnedMessageContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `PinnedMessageContext`<`Bot`>, `PinnedMessageContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new PinnedMessageContext**<`Bot`>(`options`): `PinnedMessageContext`<`Bot`>

Defined in: contexts/index.d.ts:6216

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `PinnedMessageContextOptions`<`Bot`> |

#### Returns

`PinnedMessageContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new PinnedMessageContext**(...`args`): `PinnedMessageContext`

Defined in: contexts/index.d.ts:6213

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`PinnedMessageContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6215 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventMessage

#### Get Signature

> **get** **eventMessage**(): [`MessageContext`](MessageContext.md)<`Bot`>

Defined in: contexts/index.d.ts:6218

Pinned message

##### Returns

[`MessageContext`](MessageContext.md)<`Bot`>

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `PinnedMessageContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `PinnedMessageContextOptions` |

#### Returns

`PinnedMessageContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<PinnedMessageContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<PinnedMessageContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<PinnedMessageContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<PinnedMessageContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<PinnedMessageContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<PinnedMessageContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<PinnedMessageContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<PinnedMessageContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<PinnedMessageContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<PinnedMessageContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<PinnedMessageContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<PinnedMessageContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/PinsMixin.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PinsMixin

# Class: PinsMixin\<Bot>

Defined in: contexts/index.d.ts:5193

This object represents a mixin that ensures you have methods to pin/unpin messages in the chat

## Extends

* [`Context`](Context.md)<`Bot`>.[`TargetMixin`](TargetMixin.md).[`NodeMixin`](NodeMixin.md)<`Bot`>

## Extended by

* [`BoostAddedContext`](BoostAddedContext.md)
* [`ChatBackgroundSetContext`](ChatBackgroundSetContext.md)
* [`ChatOwnerChangedContext`](ChatOwnerChangedContext.md)
* [`ChatOwnerLeftContext`](ChatOwnerLeftContext.md)
* [`ChatSharedContext`](ChatSharedContext.md)
* [`ChecklistTasksAddedContext`](ChecklistTasksAddedContext.md)
* [`ChecklistTasksDoneContext`](ChecklistTasksDoneContext.md)
* [`DeleteChatPhotoContext`](DeleteChatPhotoContext.md)
* [`DirectMessagePriceChangedContext`](DirectMessagePriceChangedContext.md)
* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiftContext`](GiftContext.md)
* [`GiftUpgradeSentContext`](GiftUpgradeSentContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)
* [`GroupChatCreatedContext`](GroupChatCreatedContext.md)
* [`InvoiceContext`](InvoiceContext.md)
* [`LeftChatMemberContext`](LeftChatMemberContext.md)
* [`LocationContext`](LocationContext.md)
* [`MessageAutoDeleteTimerChangedContext`](MessageAutoDeleteTimerChangedContext.md)
* [`MessageContext`](MessageContext.md)
* [`MigrateFromChatIdContext`](MigrateFromChatIdContext.md)
* [`MigrateToChatIdContext`](MigrateToChatIdContext.md)
* [`NewChatMembersContext`](NewChatMembersContext.md)
* [`NewChatPhotoContext`](NewChatPhotoContext.md)
* [`NewChatTitleContext`](NewChatTitleContext.md)
* [`PaidMessagePriceChangedContext`](PaidMessagePriceChangedContext.md)
* [`PassportDataContext`](PassportDataContext.md)
* [`PinnedMessageContext`](PinnedMessageContext.md)
* [`ProximityAlertTriggeredContext`](ProximityAlertTriggeredContext.md)
* [`RefundedPaymentContext`](RefundedPaymentContext.md)
* [`SuccessfulPaymentContext`](SuccessfulPaymentContext.md)
* [`SuggestedPostApprovalFailedContext`](SuggestedPostApprovalFailedContext.md)
* [`SuggestedPostApprovedContext`](SuggestedPostApprovedContext.md)
* [`SuggestedPostDeclinedContext`](SuggestedPostDeclinedContext.md)
* [`SuggestedPostPaidContext`](SuggestedPostPaidContext.md)
* [`SuggestedPostRefundedContext`](SuggestedPostRefundedContext.md)
* [`UniqueGiftContext`](UniqueGiftContext.md)
* [`UsersSharedContext`](UsersSharedContext.md)
* [`VideoChatEndedContext`](VideoChatEndedContext.md)
* [`VideoChatParticipantsInvitedContext`](VideoChatParticipantsInvitedContext.md)
* [`VideoChatScheduledContext`](VideoChatScheduledContext.md)
* [`VideoChatStartedContext`](VideoChatStartedContext.md)
* [`WriteAccessAllowedContext`](WriteAccessAllowedContext.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new PinsMixin**<`Bot`>(): `PinsMixin`<`Bot`>

#### Returns

`PinsMixin`<`Bot`>

#### Inherited from

[`Context`](Context.md).[`constructor`](Context.md#constructor)

## Properties

| Property | Modifier | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | [`NodeMixin`](NodeMixin.md).[`isTopicMessage`](NodeMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | `Record`<`string`, `any`> | [`TargetMixin`](TargetMixin.md).[`payload`](TargetMixin.md#payload) | contexts/index.d.ts:4740 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4765

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`businessConnectionId`](TargetMixin.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4759

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chat`](TargetMixin.md#chat)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4744

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`from`](TargetMixin.md#from)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4944

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`id`](NodeMixin.md#id)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:4757

*Optional*. If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderBoostCount`](TargetMixin.md#senderboostcount)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4753

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderChat`](TargetMixin.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`threadId`](NodeMixin.md#threadid)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`getChatBoosts`](NodeMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<PinsMixin\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<PinsMixin\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<PinsMixin<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<PinsMixin<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isChannel()

> **isChannel**(): `this is RequireValue<PinsMixin<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<PinsMixin<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isGroup()

> **isGroup**(): `this is RequireValue<PinsMixin<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<PinsMixin<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPM()

> **isPM**(): `this is RequireValue<PinsMixin<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<PinsMixin<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<PinsMixin<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<PinsMixin<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`send`](NodeMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendAnimation`](NodeMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendAudio`](NodeMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendChatAction`](NodeMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendChecklist`](NodeMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendContact`](NodeMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendDice`](NodeMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendDocument`](NodeMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendInvoice`](NodeMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendLocation`](NodeMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendMedia`](NodeMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendMediaGroup`](NodeMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendMessageDraft`](NodeMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendPaidMedia`](NodeMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendPhoto`](NodeMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendPoll`](NodeMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendSticker`](NodeMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVenue`](NodeMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVideo`](NodeMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVideoNote`](NodeMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`sendVoice`](NodeMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopPoll`](NodeMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`streamMessage`](NodeMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

---

---
url: 'https://gramio.dev/api/gramio/classes/Plugin.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / Plugin

# Class: Plugin\<Errors, Derives, Macros>

Defined in: gramio/index.d.ts:120

`Plugin` is an object  from which you can extends in Bot instance and adopt types

## Example

```ts
import { Plugin, Bot } from "gramio";

export class PluginError extends Error {
    wow: "type" | "safe" = "type";
}

const plugin = new Plugin("gramio-example")
    .error("PLUGIN", PluginError)
    .derive(() => {
        return {
            some: ["derived", "props"] as const,
        };
    });

const bot = new Bot(process.env.TOKEN!)
    .extend(plugin)
    .onError(({ context, kind, error }) => {
        if (context.is("message") && kind === "PLUGIN") {
            console.log(error.wow);
        }
    })
    .use((context) => {
        console.log(context.some);
    });
```

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Errors` *extends* [`ErrorDefinitions`](../type-aliases/ErrorDefinitions.md) | `object` |
| `Derives` *extends* [`DeriveDefinitions`](../type-aliases/DeriveDefinitions.md) | [`DeriveDefinitions`](../type-aliases/DeriveDefinitions.md) |
| `Macros` *extends* [`MacroDefinitions`](../../../composer/type-aliases/MacroDefinitions.md) | `object` |

## Constructors

### Constructor

> **new Plugin**<`Errors`, `Derives`, `Macros`>(`name`, `__namedParameters?`): `Plugin`<`Errors`, `Derives`, `Macros`>

Defined in: gramio/index.d.ts:376

Create new Plugin. Please provide `name`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `__namedParameters?` | { `dependencies?`: `string`\[]; } |
| `__namedParameters.dependencies?` | `string`\[] |

#### Returns

`Plugin`<`Errors`, `Derives`, `Macros`>

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `_` | `object` | **`Internal`** Set of Plugin data | gramio/index.d.ts:127 |
| `_.composer` | [`EventComposer`](../../../composer/interfaces/EventComposer.md)<[`Context`](../../../contexts/classes/Context.md)<[`AnyBot`](../type-aliases/AnyBot.md)>, { `boost_added`: [`BoostAddedContext`](../../../contexts/classes/BoostAddedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `business_connection`: [`BusinessConnectionContext`](../../../contexts/classes/BusinessConnectionContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `business_message`: [`MessageContext`](../../../contexts/classes/MessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)> & [`Require`](../../../contexts/type-aliases/Require.md)<[`MessageContext`](../../../contexts/classes/MessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>, `"from"`>; `callback_query`: [`CallbackQueryContext`](../../../contexts/classes/CallbackQueryContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `channel_post`: [`MessageContext`](../../../contexts/classes/MessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `chat_background_set`: [`ChatBackgroundSetContext`](../../../contexts/classes/ChatBackgroundSetContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `chat_boost`: [`ChatBoostContext`](../../../contexts/classes/ChatBoostContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `chat_join_request`: [`ChatJoinRequestContext`](../../../contexts/classes/ChatJoinRequestContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `chat_member`: [`ChatMemberContext`](../../../contexts/classes/ChatMemberContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `chat_owner_changed`: [`ChatOwnerChangedContext`](../../../contexts/classes/ChatOwnerChangedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `chat_owner_left`: [`ChatOwnerLeftContext`](../../../contexts/classes/ChatOwnerLeftContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `chat_shared`: [`ChatSharedContext`](../../../contexts/classes/ChatSharedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `checklist_tasks_added`: [`ChecklistTasksAddedContext`](../../../contexts/classes/ChecklistTasksAddedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `checklist_tasks_done`: [`ChecklistTasksDoneContext`](../../../contexts/classes/ChecklistTasksDoneContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `chosen_inline_result`: [`ChosenInlineResultContext`](../../../contexts/classes/ChosenInlineResultContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `delete_chat_photo`: [`DeleteChatPhotoContext`](../../../contexts/classes/DeleteChatPhotoContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `deleted_business_messages`: [`BusinessMessagesDeletedContext`](../../../contexts/classes/BusinessMessagesDeletedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `direct_message_price_changed`: [`DirectMessagePriceChangedContext`](../../../contexts/classes/DirectMessagePriceChangedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `edited_business_message`: [`MessageContext`](../../../contexts/classes/MessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)> & [`Require`](../../../contexts/type-aliases/Require.md)<[`MessageContext`](../../../contexts/classes/MessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>, `"from"`>; `edited_channel_post`: [`MessageContext`](../../../contexts/classes/MessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)> & [`Require`](../../../contexts/type-aliases/Require.md)<[`MessageContext`](../../../contexts/classes/MessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>, `"from"`>; `edited_message`: [`MessageContext`](../../../contexts/classes/MessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)> & [`Require`](../../../contexts/type-aliases/Require.md)<[`MessageContext`](../../../contexts/classes/MessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>, `"from"`>; `forum_topic_closed`: [`ForumTopicClosedContext`](../../../contexts/classes/ForumTopicClosedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `forum_topic_created`: [`ForumTopicCreatedContext`](../../../contexts/classes/ForumTopicCreatedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `forum_topic_edited`: [`ForumTopicEditedContext`](../../../contexts/classes/ForumTopicEditedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `forum_topic_reopened`: [`ForumTopicReopenedContext`](../../../contexts/classes/ForumTopicReopenedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `general_forum_topic_hidden`: [`GeneralForumTopicHiddenContext`](../../../contexts/classes/GeneralForumTopicHiddenContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `general_forum_topic_unhidden`: [`GeneralForumTopicUnhiddenContext`](../../../contexts/classes/GeneralForumTopicUnhiddenContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `gift`: [`GiftContext`](../../../contexts/classes/GiftContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `gift_upgrade_sent`: [`GiftUpgradeSentContext`](../../../contexts/classes/GiftUpgradeSentContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `giveaway_completed`: [`GiveawayCompletedContext`](../../../contexts/classes/GiveawayCompletedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `giveaway_created`: [`GiveawayCreatedContext`](../../../contexts/classes/GiveawayCreatedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `giveaway_winners`: [`GiveawayWinnersContext`](../../../contexts/classes/GiveawayWinnersContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `group_chat_created`: [`GroupChatCreatedContext`](../../../contexts/classes/GroupChatCreatedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `inline_query`: [`InlineQueryContext`](../../../contexts/classes/InlineQueryContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `invoice`: [`InvoiceContext`](../../../contexts/classes/InvoiceContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `left_chat_member`: [`LeftChatMemberContext`](../../../contexts/classes/LeftChatMemberContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `location`: [`LocationContext`](../../../contexts/classes/LocationContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `message`: [`MessageContext`](../../../contexts/classes/MessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)> & [`Require`](../../../contexts/type-aliases/Require.md)<[`MessageContext`](../../../contexts/classes/MessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>, `"from"`>; `message_auto_delete_timer_changed`: [`MessageAutoDeleteTimerChangedContext`](../../../contexts/classes/MessageAutoDeleteTimerChangedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `message_reaction`: [`MessageReactionContext`](../../../contexts/classes/MessageReactionContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `message_reaction_count`: [`MessageReactionCountContext`](../../../contexts/classes/MessageReactionCountContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `migrate_from_chat_id`: [`MigrateFromChatIdContext`](../../../contexts/classes/MigrateFromChatIdContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `migrate_to_chat_id`: [`MigrateToChatIdContext`](../../../contexts/classes/MigrateToChatIdContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `my_chat_member`: [`ChatMemberContext`](../../../contexts/classes/ChatMemberContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `new_chat_members`: [`NewChatMembersContext`](../../../contexts/classes/NewChatMembersContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `new_chat_photo`: [`NewChatPhotoContext`](../../../contexts/classes/NewChatPhotoContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `new_chat_title`: [`NewChatTitleContext`](../../../contexts/classes/NewChatTitleContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `paid_message_price_changed`: [`PaidMessagePriceChangedContext`](../../../contexts/classes/PaidMessagePriceChangedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `passport_data`: [`PassportDataContext`](../../../contexts/classes/PassportDataContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `pinned_message`: [`PinnedMessageContext`](../../../contexts/classes/PinnedMessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `poll`: [`PollContext`](../../../contexts/classes/PollContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `poll_answer`: [`PollAnswerContext`](../../../contexts/classes/PollAnswerContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `pre_checkout_query`: [`PreCheckoutQueryContext`](../../../contexts/classes/PreCheckoutQueryContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `proximity_alert_triggered`: [`ProximityAlertTriggeredContext`](../../../contexts/classes/ProximityAlertTriggeredContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `purchased_paid_media`: [`PaidMediaPurchasedContext`](../../../contexts/classes/PaidMediaPurchasedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `refunded_payment`: [`RefundedPaymentContext`](../../../contexts/classes/RefundedPaymentContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `removed_chat_boost`: [`RemovedChatBoostContext`](../../../contexts/classes/RemovedChatBoostContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `service_message`: [`MessageContext`](../../../contexts/classes/MessageContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `shipping_query`: [`ShippingQueryContext`](../../../contexts/classes/ShippingQueryContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `successful_payment`: [`SuccessfulPaymentContext`](../../../contexts/classes/SuccessfulPaymentContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `suggested_post_approval_failed`: [`SuggestedPostApprovalFailedContext`](../../../contexts/classes/SuggestedPostApprovalFailedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `suggested_post_approved`: [`SuggestedPostApprovedContext`](../../../contexts/classes/SuggestedPostApprovedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `suggested_post_declined`: [`SuggestedPostDeclinedContext`](../../../contexts/classes/SuggestedPostDeclinedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `suggested_post_paid`: [`SuggestedPostPaidContext`](../../../contexts/classes/SuggestedPostPaidContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `suggested_post_refunded`: [`SuggestedPostRefundedContext`](../../../contexts/classes/SuggestedPostRefundedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `unique_gift`: [`UniqueGiftContext`](../../../contexts/classes/UniqueGiftContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `users_shared`: [`UsersSharedContext`](../../../contexts/classes/UsersSharedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `video_chat_ended`: [`VideoChatEndedContext`](../../../contexts/classes/VideoChatEndedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `video_chat_participants_invited`: [`VideoChatParticipantsInvitedContext`](../../../contexts/classes/VideoChatParticipantsInvitedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `video_chat_scheduled`: [`VideoChatScheduledContext`](../../../contexts/classes/VideoChatScheduledContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `video_chat_started`: [`VideoChatStartedContext`](../../../contexts/classes/VideoChatStartedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `web_app_data`: [`WebAppDataContext`](../../../contexts/classes/WebAppDataContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; `write_access_allowed`: [`WriteAccessAllowedContext`](../../../contexts/classes/WriteAccessAllowedContext.md)<[`AnyBot`](../type-aliases/AnyBot.md)>; }, [`Context`](../../../contexts/classes/Context.md)<[`AnyBot`](../type-aliases/AnyBot.md)>, [`Context`](../../../contexts/classes/Context.md)<[`AnyBot`](../type-aliases/AnyBot.md)>, { }, { }, { `callbackQuery`: `TThis`; `chosenInlineResult`: `TThis`; `command`: `TThis`; `hears`: `TThis`; `inlineQuery`: `TThis`; `reaction`: `TThis`; `startParameter`: `TThis`; }, { }> & `object` | Composer | gramio/index.d.ts:139 |
| `_.decorators` | `Record`<`string`, `unknown`> | - | gramio/index.d.ts:371 |
| `_.dependencies` | `string`\[] | List of plugin dependencies. If user does't extend from listed there dependencies it throw a error | gramio/index.d.ts:131 |
| `_.Derives` | `Derives` | remap generic type. {} in runtime | gramio/index.d.ts:135 |
| `_.Errors` | `Errors` | remap generic type. {} in runtime | gramio/index.d.ts:133 |
| `_.errorsDefinitions` | `Record`<`string`, {(...`args`): `any`; `prototype`: `Error`; }> | Map of plugin errors | gramio/index.d.ts:367 |
| `_.groups` | (`bot`) => [`AnyBot`](../type-aliases/AnyBot.md)\[] | Store plugin groups If you use `on` or `use` in group and on plugin-level groups handlers are registered after plugin-level handlers | gramio/index.d.ts:359 |
| `_.Macros` | `Macros` | remap generic type. {} in runtime | gramio/index.d.ts:137 |
| `_.name` | `string` | Name of plugin | gramio/index.d.ts:129 |
| `_.onApiCalls` | \[[`OnApiCall`](../namespaces/Hooks/type-aliases/OnApiCall.md)<`any`>, `MaybeArray`\<keyof [`APIMethods`](../interfaces/APIMethods.md)>]\[] | Store plugin onApiCalls hooks | gramio/index.d.ts:353 |
| `_.onErrors` | [`OnError`](../namespaces/Hooks/type-aliases/OnError.md)<`any`, `any`>\[] | Store plugin onErrors hooks | gramio/index.d.ts:365 |
| `_.onResponseErrors` | \[[`OnResponseError`](../namespaces/Hooks/type-aliases/OnResponseError.md)<`any`>, `MaybeArray`\<keyof [`APIMethods`](../interfaces/APIMethods.md)>]\[] | Store plugin onResponseErrors hooks | gramio/index.d.ts:351 |
| `_.onResponses` | \[[`OnResponse`](../namespaces/Hooks/type-aliases/OnResponse.md)<`any`>, `MaybeArray`\<keyof [`APIMethods`](../interfaces/APIMethods.md)>]\[] | Store plugin onResponses hooks | gramio/index.d.ts:349 |
| `_.onStarts` | [`OnStart`](../namespaces/Hooks/type-aliases/OnStart.md)\[] | Store plugin onStarts hooks | gramio/index.d.ts:361 |
| `_.onStops` | [`OnStop`](../namespaces/Hooks/type-aliases/OnStop.md)\[] | Store plugin onStops hooks | gramio/index.d.ts:363 |
| `_.preRequests` | \[[`PreRequest`](../namespaces/Hooks/type-aliases/PreRequest.md)<`any`>, `MaybeArray`\<keyof [`APIMethods`](../interfaces/APIMethods.md)>]\[] | Store plugin preRequests hooks | gramio/index.d.ts:347 |

## Accessors

### ~

#### Get Signature

> **get** **~**(): `object`

Defined in: gramio/index.d.ts:374

Expose composer internals so `composer.extend(plugin)` works via duck-typing

##### Returns

| Name | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `compiled` | [`ComposedMiddleware`](../../../composer/type-aliases/ComposedMiddleware.md)<`any`> | - | composer/index.d.ts:311 |
| `Derives` | `TDerives` | - | composer/index.d.ts:320 |
| `errorsDefinitions` | `Record`<`string`, {(...`args`): `any`; `prototype`: `Error`; }> | - | composer/index.d.ts:314 |
| `extended` | `Set`<`string`> | - | composer/index.d.ts:310 |
| `macros` | `Record`<`string`, [`MacroDef`](../../../composer/type-aliases/MacroDef.md)<`any`, `any`>> | - | composer/index.d.ts:319 |
| `middlewares` | `ScopedMiddleware`<`any`>\[] | - | composer/index.d.ts:308 |
| `name` | `string` | - | composer/index.d.ts:312 |
| `onErrors` | [`ErrorHandler`](../../../composer/type-aliases/ErrorHandler.md)<`any`>\[] | - | composer/index.d.ts:309 |
| `Out` | [`Context`](../../../contexts/classes/Context.md) | Phantom type accessor — never set at runtime, used by `ContextOf<T>` | composer/index.d.ts:322 |
| `seed` | `unknown` | - | composer/index.d.ts:313 |
| `tracer` | [`TraceHandler`](../../../composer/type-aliases/TraceHandler.md) | - | composer/index.d.ts:318 |

## Methods

### decorate()

#### Call Signature

> **decorate**<`Value`>(`value`): `Plugin`<`Errors`, `Derives` & `object`, `Macros`>

Defined in: gramio/index.d.ts:410

##### Type Parameters

| Type Parameter |
| ------ |
| `Value` *extends* `Record`<`string`, `any`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `Value` |

##### Returns

`Plugin`<`Errors`, `Derives` & `object`, `Macros`>

#### Call Signature

> **decorate**<`Name`, `Value`>(`name`, `value`): `Plugin`<`Errors`, `Derives` & `object`, `Macros`>

Defined in: gramio/index.d.ts:415

##### Type Parameters

| Type Parameter |
| ------ |
| `Name` *extends* `string` |
| `Value` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `Name` |
| `value` | `Value` |

##### Returns

`Plugin`<`Errors`, `Derives` & `object`, `Macros`>

***

### derive()

#### Call Signature

> **derive**<`Handler`>(`handler`): `Plugin`<`Errors`, `Derives` & `object`, `Macros`>

Defined in: gramio/index.d.ts:404

Derive some data to handlers

##### Type Parameters

| Type Parameter |
| ------ |
| `Handler` *extends* [`Derive`](../namespaces/Hooks/type-aliases/Derive.md)<[`Context`](../../../contexts/classes/Context.md)<[`BotLike`](../../../contexts/interfaces/BotLike.md)> & `Derives`\[`"global"`]> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | `Handler` |

##### Returns

`Plugin`<`Errors`, `Derives` & `object`, `Macros`>

##### Example

```ts
new Bot("token").derive((context) => {
		return {
			superSend: () => context.send("Derived method")
		}
})
```

#### Call Signature

> **derive**<`Update`, `Handler`>(`updateName`, `handler`): `Plugin`<`Errors`, `Derives` & `{ [K in UpdateName]: Awaited<ReturnType<Handler>> }`, `Macros`>

Defined in: gramio/index.d.ts:407

Derive some data to handlers

##### Type Parameters

| Type Parameter |
| ------ |
| `Update` *extends* [`UpdateName`](../../../contexts/type-aliases/UpdateName.md) |
| `Handler` *extends* [`Derive`](../namespaces/Hooks/type-aliases/Derive.md)<`InstanceType`<[`ContextsMapping`](../../../contexts/type-aliases/ContextsMapping.md)<[`BotLike`](../../../contexts/interfaces/BotLike.md)>\[`Update`]> & `object` & `Record`<[`UpdateName`](../../../contexts/type-aliases/UpdateName.md) | `"global"`, { }>\[`Update`] & `Derives`\[`"global"`] & `Derives`\[`Update`]> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `updateName` | `MaybeArray`<`Update`> |
| `handler` | `Handler` |

##### Returns

`Plugin`<`Errors`, `Derives` & `{ [K in UpdateName]: Awaited<ReturnType<Handler>> }`, `Macros`>

##### Example

```ts
new Bot("token").derive((context) => {
		return {
			superSend: () => context.send("Derived method")
		}
})
```

***

### error()

> **error**<`Name`, `NewError`>(`kind`, `error`): `Plugin`<`Errors` & `{ [name in string]: InstanceType<NewError> }`, `Derives`, `Macros`>

Defined in: gramio/index.d.ts:388

Register custom class-error in plugin

#### Type Parameters

| Type Parameter |
| ------ |
| `Name` *extends* `string` |
| `NewError` *extends* {(...`args`): `any`; `prototype`: `Error`; } |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `kind` | `Name` |
| `error` | `NewError` |

#### Returns

`Plugin`<`Errors` & `{ [name in string]: InstanceType<NewError> }`, `Derives`, `Macros`>

***

### extend()

#### Call Signature

> **extend**<`UExposed`, `UDerives`>(`composer`): `Plugin`<`Errors`, `Derives` & `object` & `UDerives`>

Defined in: gramio/index.d.ts:543

Extend plugin with a Composer instance (merges middleware with deduplication)

##### Type Parameters

| Type Parameter |
| ------ |
| `UExposed` *extends* `object` |
| `UDerives` *extends* `Record`<`string`, `object`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `composer` | [`EventComposer`](../../../composer/interfaces/EventComposer.md)<`any`, `any`, `any`, `any`, `UExposed`, `UDerives`> |

##### Returns

`Plugin`<`Errors`, `Derives` & `object` & `UDerives`>

#### Call Signature

> **extend**<`NewPlugin`>(`plugin`): `Plugin`<`Errors` & `NewPlugin`\[`"_"`]\[`"Errors"`], `Derives` & `NewPlugin`\[`"_"`]\[`"Derives"`]>

Defined in: gramio/index.d.ts:548

! \*\* At the moment, it can only pick up types\*\*

##### Type Parameters

| Type Parameter |
| ------ |
| `NewPlugin` *extends* [`AnyPlugin`](../type-aliases/AnyPlugin.md) |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `plugin` | [`MaybePromise`](../type-aliases/MaybePromise.md)<`NewPlugin`> |

##### Returns

`Plugin`<`Errors` & `NewPlugin`\[`"_"`]\[`"Errors"`], `Derives` & `NewPlugin`\[`"_"`]\[`"Derives"`]>

***

### group()

> **group**(`grouped`): `this`

Defined in: gramio/index.d.ts:384

Currently not isolated!!!

> \[!WARNING]
> If you use `on` or `use` in a `group` and at the plugin level, the group handlers are registered **after** the handlers at the plugin level

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `grouped` | (`bot`) => [`AnyBot`](../type-aliases/AnyBot.md) |

#### Returns

`this`

***

### macro()

#### Call Signature

> **macro**<`Name`, `TDef`>(`name`, `definition`): `Plugin`<`Errors`, `Derives`, `Macros` & `Record`<`Name`, `TDef`>>

Defined in: gramio/index.d.ts:423

Register a single named macro definition on this plugin

##### Type Parameters

| Type Parameter |
| ------ |
| `Name` *extends* `string` |
| `TDef` *extends* [`MacroDef`](../../../composer/type-aliases/MacroDef.md)<`any`, `any`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `Name` |
| `definition` | `TDef` |

##### Returns

`Plugin`<`Errors`, `Derives`, `Macros` & `Record`<`Name`, `TDef`>>

#### Call Signature

> **macro**<`TDefs`>(`definitions`): `Plugin`<`Errors`, `Derives`, `Macros` & `TDefs`>

Defined in: gramio/index.d.ts:425

Register multiple macro definitions at once

##### Type Parameters

| Type Parameter |
| ------ |
| `TDefs` *extends* `Record`<`string`, [`MacroDef`](../../../composer/type-aliases/MacroDef.md)<`any`, `any`>> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `definitions` | `TDefs` |

##### Returns

`Plugin`<`Errors`, `Derives`, `Macros` & `TDefs`>

***

### on()

#### Call Signature

> **on**<`Narrowing`>(`filter`, `handler`): `this`

Defined in: gramio/index.d.ts:427

Register handler with a type-narrowing filter (auto-discovers matching events)

##### Type Parameters

| Type Parameter |
| ------ |
| `Narrowing` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `filter` | (`ctx`) => `ctx is Narrowing` |
| `handler` | [`Handler`](../type-aliases/Handler.md)<`InstanceType`<[`ContextsMapping`](../../../contexts/type-aliases/ContextsMapping.md)<[`BotLike`](../../../contexts/interfaces/BotLike.md)>\[`CompatibleUpdates$1`<[`BotLike`](../../../contexts/interfaces/BotLike.md), `Narrowing`>]> & `object` & `Record`<[`UpdateName`](../../../contexts/type-aliases/UpdateName.md) | `"global"`, { }>\[`CompatibleUpdates$1`<[`BotLike`](../../../contexts/interfaces/BotLike.md), `Narrowing`>] & `Derives`\[`"global"`] & `Narrowing`> |

##### Returns

`this`

#### Call Signature

> **on**(`filter`, `handler`): `this`

Defined in: gramio/index.d.ts:429

Register handler with a boolean filter (all updates)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `filter` | (`ctx`) => `boolean` |
| `handler` | [`Handler`](../type-aliases/Handler.md)<[`Context`](../../../contexts/classes/Context.md)<[`BotLike`](../../../contexts/interfaces/BotLike.md)> & `Derives`\[`"global"`]> |

##### Returns

`this`

#### Call Signature

> **on**<`T`, `Narrowing`>(`updateName`, `filter`, `handler`): `this`

Defined in: gramio/index.d.ts:431

Register handler to one or many Updates with a type-narrowing filter

##### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../../../contexts/type-aliases/UpdateName.md) |
| `Narrowing` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `updateName` | `MaybeArray`<`T`> |
| `filter` | (`ctx`) => `ctx is Narrowing` |
| `handler` | [`Handler`](../type-aliases/Handler.md)<`InstanceType`<[`ContextsMapping`](../../../contexts/type-aliases/ContextsMapping.md)<[`BotLike`](../../../contexts/interfaces/BotLike.md)>\[`T`]> & `object` & `Record`<[`UpdateName`](../../../contexts/type-aliases/UpdateName.md) | `"global"`, { }>\[`T`] & `Derives`\[`"global"`] & `Derives`\[`T`] & `Narrowing`> |

##### Returns

`this`

#### Call Signature

> **on**<`T`>(`updateName`, `filter`, `handler`): `this`

Defined in: gramio/index.d.ts:433

Register handler to one or many Updates with a boolean filter (no type narrowing)

##### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../../../contexts/type-aliases/UpdateName.md) |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `updateName` | `MaybeArray`<`T`> |
| `filter` | (`ctx`) => `boolean` |
| `handler` | [`Handler`](../type-aliases/Handler.md)<`InstanceType`<[`ContextsMapping`](../../../contexts/type-aliases/ContextsMapping.md)<[`BotLike`](../../../contexts/interfaces/BotLike.md)>\[`T`]> & `object` & `Record`<[`UpdateName`](../../../contexts/type-aliases/UpdateName.md) | `"global"`, { }>\[`T`] & `Derives`\[`"global"`] & `Derives`\[`T`]> |

##### Returns

`this`

#### Call Signature

> **on**<`T`>(`updateName`, `handler`): `this`

Defined in: gramio/index.d.ts:435

Register handler to one or many Updates

##### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../../../contexts/type-aliases/UpdateName.md) |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `updateName` | `MaybeArray`<`T`> |
| `handler` | [`Handler`](../type-aliases/Handler.md)<`InstanceType`<[`ContextsMapping`](../../../contexts/type-aliases/ContextsMapping.md)<[`BotLike`](../../../contexts/interfaces/BotLike.md)>\[`T`]> & `object` & `Record`<[`UpdateName`](../../../contexts/type-aliases/UpdateName.md) | `"global"`, { }>\[`T`] & `Derives`\[`"global"`] & `Derives`\[`T`]> |

##### Returns

`this`

***

### onApiCall()

#### Call Signature

> **onApiCall**<`Methods`, `Handler`>(`methods`, `handler`): `this`

Defined in: gramio/index.d.ts:487

This hook wraps the entire API call, enabling tracing/instrumentation.

##### Type Parameters

| Type Parameter |
| ------ |
| `Methods` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |
| `Handler` *extends* [`OnApiCall`](../namespaces/Hooks/type-aliases/OnApiCall.md)<`Methods`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `methods` | `MaybeArray`<`Methods`> |
| `handler` | `Handler` |

##### Returns

`this`

##### Example

```typescript
const plugin = new Plugin("example").onApiCall(async (context, next) => {
    console.log(`Calling ${context.method}`);
    const result = await next();
    console.log(`${context.method} completed`);
    return result;
});
```

#### Call Signature

> **onApiCall**(`handler`): `this`

Defined in: gramio/index.d.ts:488

This hook wraps the entire API call, enabling tracing/instrumentation.

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`OnApiCall`](../namespaces/Hooks/type-aliases/OnApiCall.md) |

##### Returns

`this`

##### Example

```typescript
const plugin = new Plugin("example").onApiCall(async (context, next) => {
    console.log(`Calling ${context.method}`);
    const result = await next();
    console.log(`${context.method} completed`);
    return result;
});
```

***

### onError()

#### Call Signature

> **onError**<`T`>(`updateName`, `handler`): `this`

Defined in: gramio/index.d.ts:540

Set error handler.

##### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../../../contexts/type-aliases/UpdateName.md) |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `updateName` | `MaybeArray`<`T`> |
| `handler` | [`OnError`](../namespaces/Hooks/type-aliases/OnError.md)<`Errors`, `InstanceType`<[`ContextsMapping`](../../../contexts/type-aliases/ContextsMapping.md)<[`BotLike`](../../../contexts/interfaces/BotLike.md)>\[`T`]> & `object` & `Record`<[`UpdateName`](../../../contexts/type-aliases/UpdateName.md) | `"global"`, { }>\[`T`] & `Derives`\[`"global"`] & `Derives`\[`T`]> |

##### Returns

`this`

##### Example

```ts
bot.onError("message", ({ context, kind, error }) => {
	return context.send(`${kind}: ${error.message}`);
})
```

#### Call Signature

> **onError**(`handler`): `this`

Defined in: gramio/index.d.ts:541

Set error handler.

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`OnError`](../namespaces/Hooks/type-aliases/OnError.md)<`Errors`, [`Context`](../../../contexts/classes/Context.md)<[`BotLike`](../../../contexts/interfaces/BotLike.md)> & `Derives`\[`"global"`]> |

##### Returns

`this`

##### Example

```ts
bot.onError("message", ({ context, kind, error }) => {
	return context.send(`${kind}: ${error.message}`);
})
```

***

### onResponse()

#### Call Signature

> **onResponse**<`Methods`, `Handler`>(`methods`, `handler`): `this`

Defined in: gramio/index.d.ts:465

This hook called when API return successful response

[Documentation](https://gramio.dev/hooks/on-response.html)

##### Type Parameters

| Type Parameter |
| ------ |
| `Methods` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |
| `Handler` *extends* [`OnResponse`](../namespaces/Hooks/type-aliases/OnResponse.md)<`Methods`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `methods` | `MaybeArray`<`Methods`> |
| `handler` | `Handler` |

##### Returns

`this`

#### Call Signature

> **onResponse**(`handler`): `this`

Defined in: gramio/index.d.ts:466

This hook called when API return successful response

[Documentation](https://gramio.dev/hooks/on-response.html)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`OnResponse`](../namespaces/Hooks/type-aliases/OnResponse.md) |

##### Returns

`this`

***

### onResponseError()

#### Call Signature

> **onResponseError**<`Methods`, `Handler`>(`methods`, `handler`): `this`

Defined in: gramio/index.d.ts:472

This hook called when API return an error

[Documentation](https://gramio.dev/hooks/on-response-error.html)

##### Type Parameters

| Type Parameter |
| ------ |
| `Methods` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |
| `Handler` *extends* [`OnResponseError`](../namespaces/Hooks/type-aliases/OnResponseError.md)<`Methods`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `methods` | `MaybeArray`<`Methods`> |
| `handler` | `Handler` |

##### Returns

`this`

#### Call Signature

> **onResponseError**(`handler`): `this`

Defined in: gramio/index.d.ts:473

This hook called when API return an error

[Documentation](https://gramio.dev/hooks/on-response-error.html)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`OnResponseError`](../namespaces/Hooks/type-aliases/OnResponseError.md) |

##### Returns

`this`

***

### onStart()

> **onStart**(`handler`): `this`

Defined in: gramio/index.d.ts:509

This hook called when the bot is `started`.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`OnStart`](../namespaces/Hooks/type-aliases/OnStart.md) |

#### Returns

`this`

#### Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).onStart(
    ({ plugins, info, updatesFrom }) => {
        console.log(`plugin list - ${plugins.join(", ")}`);
        console.log(`bot username is @${info.username}`);
		   console.log(`updates from ${updatesFrom}`);
    }
);

bot.start();
```

[Documentation](https://gramio.dev/hooks/on-start.html)

***

### onStop()

> **onStop**(`handler`): `this`

Defined in: gramio/index.d.ts:530

This hook called when the bot stops.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`OnStop`](../namespaces/Hooks/type-aliases/OnStop.md) |

#### Returns

`this`

#### Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).onStop(
    ({ plugins, info, updatesFrom }) => {
        console.log(`plugin list - ${plugins.join(", ")}`);
        console.log(`bot username is @${info.username}`);
    }
);

bot.start();
bot.stop();
```

[Documentation](https://gramio.dev/hooks/on-stop.html)

***

### preRequest()

#### Call Signature

> **preRequest**<`Methods`, `Handler`>(`methods`, `handler`): `this`

Defined in: gramio/index.d.ts:458

This hook called before sending a request to Telegram Bot API (allows us to impact the sent parameters).

##### Type Parameters

| Type Parameter |
| ------ |
| `Methods` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |
| `Handler` *extends* [`PreRequest`](../namespaces/Hooks/type-aliases/PreRequest.md)<`Methods`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `methods` | `MaybeArray`<`Methods`> |
| `handler` | `Handler` |

##### Returns

`this`

##### Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).preRequest((context) => {
    if (context.method === "sendMessage") {
        context.params.text = "mutate params";
    }

    return context;
});

bot.start();
```

[Documentation](https://gramio.dev/hooks/pre-request.html)

#### Call Signature

> **preRequest**(`handler`): `this`

Defined in: gramio/index.d.ts:459

This hook called before sending a request to Telegram Bot API (allows us to impact the sent parameters).

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`PreRequest`](../namespaces/Hooks/type-aliases/PreRequest.md) |

##### Returns

`this`

##### Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).preRequest((context) => {
    if (context.method === "sendMessage") {
        context.params.text = "mutate params";
    }

    return context;
});

bot.start();
```

[Documentation](https://gramio.dev/hooks/pre-request.html)

***

### use()

> **use**(`handler`): `this`

Defined in: gramio/index.d.ts:437

Register handler to any Updates

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`Handler`](../type-aliases/Handler.md)<[`Context`](../../../contexts/classes/Context.md)<[`BotLike`](../../../contexts/interfaces/BotLike.md)> & `Derives`\[`"global"`]> |

#### Returns

`this`

---

---
url: 'https://gramio.dev/api/contexts/classes/Poll.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Poll

# Class: Poll

Defined in: contexts/index.d.ts:603

This object contains information about a poll.

## Extended by

* [`PollAttachment`](PollAttachment.md)
* [`PollContext`](PollContext.md)

## Constructors

### Constructor

> **new Poll**(`payload`): `Poll`

Defined in: contexts/index.d.ts:605

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramPoll`](../../../../gramio/interfaces/TelegramPoll.md) |

#### Returns

`Poll`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramPoll`](../../../../gramio/interfaces/TelegramPoll.md) | contexts/index.d.ts:604 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:607

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### allowsMultipleAnswers

#### Get Signature

> **get** **allowsMultipleAnswers**(): `boolean`

Defined in: contexts/index.d.ts:627

`true`, if the poll allows multiple answers

##### Returns

`boolean`

***

### closeDate

#### Get Signature

> **get** **closeDate**(): `number`

Defined in: contexts/index.d.ts:649

Point in time (Unix timestamp) when the poll will be automatically closed

##### Returns

`number`

***

### correctOptionId

#### Get Signature

> **get** **correctOptionId**(): `number`

Defined in: contexts/index.d.ts:633

0-based identifier of the correct answer option. Available only for polls
in the quiz mode, which are closed, or was sent (not forwarded) by the bot
or to the private chat with the bot.

##### Returns

`number`

***

### explanation

#### Get Signature

> **get** **explanation**(): `string`

Defined in: contexts/index.d.ts:638

Text that is shown when a user chooses an incorrect answer or taps on the
lamp icon in a quiz-style poll, 0-200 characters

##### Returns

`string`

***

### explanationEntities

#### Get Signature

> **get** **explanationEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:643

Special entities like usernames, URLs, bot commands, etc. that appear in
the explanation

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:609

Unique poll identifier

##### Returns

`string`

***

### openPeriod

#### Get Signature

> **get** **openPeriod**(): `number`

Defined in: contexts/index.d.ts:645

Amount of time in seconds the poll will be active after creation

##### Returns

`number`

***

### options

#### Get Signature

> **get** **options**(): [`PollOption`](PollOption.md)\[]

Defined in: contexts/index.d.ts:617

List of poll options

##### Returns

[`PollOption`](PollOption.md)\[]

***

### question

#### Get Signature

> **get** **question**(): `string`

Defined in: contexts/index.d.ts:611

Poll question, `1-300` characters

##### Returns

`string`

***

### questionEntities

#### Get Signature

> **get** **questionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:615

*Optional*. Special entities that appear in the *question*. Currently, only custom emoji entities are allowed in poll questions

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

***

### totalVoterCount

#### Get Signature

> **get** **totalVoterCount**(): `number`

Defined in: contexts/index.d.ts:619

Total number of users that voted in the poll

##### Returns

`number`

***

### type

#### Get Signature

> **get** **type**(): [`TelegramPollType`](../../../../gramio/type-aliases/TelegramPollType.md)

Defined in: contexts/index.d.ts:625

Poll type, currently can be `regular` or `quiz`

##### Returns

[`TelegramPollType`](../../../../gramio/type-aliases/TelegramPollType.md)

## Methods

### isAnonymous()

> **isAnonymous**(): `boolean`

Defined in: contexts/index.d.ts:623

`true`, if the poll is anonymous

#### Returns

`boolean`

***

### isClosed()

> **isClosed**(): `boolean`

Defined in: contexts/index.d.ts:621

`true`, if the poll is closed

#### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/contexts/classes/PollAnswer.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PollAnswer

# Class: PollAnswer

Defined in: contexts/index.d.ts:4361

This object represents an answer of a user in a non-anonymous poll.

## Extended by

* [`PollAnswerContext`](PollAnswerContext.md)

## Constructors

### Constructor

> **new PollAnswer**(`payload`): `PollAnswer`

Defined in: contexts/index.d.ts:4363

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramPollAnswer`](../../../../gramio/interfaces/TelegramPollAnswer.md) |

#### Returns

`PollAnswer`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramPollAnswer`](../../../../gramio/interfaces/TelegramPollAnswer.md) | contexts/index.d.ts:4362 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4365

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### optionIds

#### Get Signature

> **get** **optionIds**(): `number`\[]

Defined in: contexts/index.d.ts:4378

0-based identifiers of answer options, chosen by the user.
May be empty if the user retracted their vote.

##### Returns

`number`\[]

***

### pollId

#### Get Signature

> **get** **pollId**(): `string`

Defined in: contexts/index.d.ts:4367

Unique poll identifier

##### Returns

`string`

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4373

Sender ID. Since `user` and `voterChat` are mutually exclusive, this field will either contain `user.id` or `voterChat.id` as a shortcut =)

##### Returns

`number`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4371

The user, who changed the answer to the poll

##### Returns

[`User`](User.md)

***

### voterChat

#### Get Signature

> **get** **voterChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4369

The chat that changed the answer to the poll, if the voter is anonymous

##### Returns

[`Chat`](Chat.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/PollAnswerContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PollAnswerContext

# Class: PollAnswerContext\<Bot>

Defined in: contexts/index.d.ts:6234

This object represents an answer of a user in a non-anonymous poll.

[Documentation](https://core.telegram.org/bots/api/#pollanswer)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`PollAnswerContext`<`Bot`>>.[`PollAnswer`](PollAnswer.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `PollAnswerContext`<`Bot`>, `PollAnswerContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new PollAnswerContext**<`Bot`>(`options`): `PollAnswerContext`<`Bot`>

Defined in: contexts/index.d.ts:6237

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `PollAnswerContextOptions`<`Bot`> |

#### Returns

`PollAnswerContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new PollAnswerContext**(...`args`): `PollAnswerContext`

Defined in: contexts/index.d.ts:6234

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`PollAnswerContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | [`TelegramPollAnswer`](../../../../gramio/interfaces/TelegramPollAnswer.md) | The raw data that is used for this Context | [`PollAnswer`](PollAnswer.md).[`payload`](PollAnswer.md#payload) | contexts/index.d.ts:6236 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4859

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### optionIds

#### Get Signature

> **get** **optionIds**(): `number`\[]

Defined in: contexts/index.d.ts:4378

0-based identifiers of answer options, chosen by the user.
May be empty if the user retracted their vote.

##### Returns

`number`\[]

#### Inherited from

[`PollAnswer`](PollAnswer.md).[`optionIds`](PollAnswer.md#optionids)

***

### pollId

#### Get Signature

> **get** **pollId**(): `string`

Defined in: contexts/index.d.ts:4367

Unique poll identifier

##### Returns

`string`

#### Inherited from

[`PollAnswer`](PollAnswer.md).[`pollId`](PollAnswer.md#pollid)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4373

Sender ID. Since `user` and `voterChat` are mutually exclusive, this field will either contain `user.id` or `voterChat.id` as a shortcut =)

##### Returns

`number`

#### Inherited from

[`PollAnswer`](PollAnswer.md).[`senderId`](PollAnswer.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4371

The user, who changed the answer to the poll

##### Returns

[`User`](User.md)

#### Inherited from

[`PollAnswer`](PollAnswer.md).[`user`](PollAnswer.md#user)

***

### voterChat

#### Get Signature

> **get** **voterChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4369

The chat that changed the answer to the poll, if the voter is anonymous

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`PollAnswer`](PollAnswer.md).[`voterChat`](PollAnswer.md#voterchat)

## Methods

### clone()

> **clone**(`options?`): `PollAnswerContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `PollAnswerContextOptions` |

#### Returns

`PollAnswerContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isFromChat()

> **isFromChat**(): `this is Require<PollAnswerContext<Bot>, "voterChat">`

Defined in: contexts/index.d.ts:6241

Checks if current answer was answered anonymously and the `voterChat` is available

#### Returns

`this is Require<PollAnswerContext<Bot>, "voterChat">`

***

### isFromUser()

> **isFromUser**(): `this is Require<PollAnswerContext<Bot>, "user">`

Defined in: contexts/index.d.ts:6239

Checks whether the current answer was non-anonymous and contains `user` field

#### Returns

`this is Require<PollAnswerContext<Bot>, "user">`

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/PollAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PollAttachment

# Class: PollAttachment

Defined in: contexts/index.d.ts:653

This object contains information about a poll.

## Extends

* [`Poll`](Poll.md).[`Attachment`](Attachment.md)

## Constructors

### Constructor

> **new PollAttachment**(`payload`): `PollAttachment`

Defined in: contexts/index.d.ts:605

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramPoll`](../../../../gramio/interfaces/TelegramPoll.md) |

#### Returns

`PollAttachment`

#### Inherited from

[`Poll`](Poll.md).[`constructor`](Poll.md#constructor)

## Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
|  `attachmentType` | [`AttachmentType`](../type-aliases/AttachmentType.md) | [`Attachment`](Attachment.md).[`attachmentType`](Attachment.md#attachmenttype) | contexts/index.d.ts:654 |
|  `payload` | [`TelegramPoll`](../../../../gramio/interfaces/TelegramPoll.md) | [`Poll`](Poll.md).[`payload`](Poll.md#payload) | contexts/index.d.ts:604 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:607

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Poll`](Poll.md).[`[toStringTag]`](Poll.md#tostringtag)

***

### allowsMultipleAnswers

#### Get Signature

> **get** **allowsMultipleAnswers**(): `boolean`

Defined in: contexts/index.d.ts:627

`true`, if the poll allows multiple answers

##### Returns

`boolean`

#### Inherited from

[`Poll`](Poll.md).[`allowsMultipleAnswers`](Poll.md#allowsmultipleanswers)

***

### closeDate

#### Get Signature

> **get** **closeDate**(): `number`

Defined in: contexts/index.d.ts:649

Point in time (Unix timestamp) when the poll will be automatically closed

##### Returns

`number`

#### Inherited from

[`Poll`](Poll.md).[`closeDate`](Poll.md#closedate)

***

### correctOptionId

#### Get Signature

> **get** **correctOptionId**(): `number`

Defined in: contexts/index.d.ts:633

0-based identifier of the correct answer option. Available only for polls
in the quiz mode, which are closed, or was sent (not forwarded) by the bot
or to the private chat with the bot.

##### Returns

`number`

#### Inherited from

[`Poll`](Poll.md).[`correctOptionId`](Poll.md#correctoptionid)

***

### explanation

#### Get Signature

> **get** **explanation**(): `string`

Defined in: contexts/index.d.ts:638

Text that is shown when a user chooses an incorrect answer or taps on the
lamp icon in a quiz-style poll, 0-200 characters

##### Returns

`string`

#### Inherited from

[`Poll`](Poll.md).[`explanation`](Poll.md#explanation)

***

### explanationEntities

#### Get Signature

> **get** **explanationEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:643

Special entities like usernames, URLs, bot commands, etc. that appear in
the explanation

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Poll`](Poll.md).[`explanationEntities`](Poll.md#explanationentities)

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:609

Unique poll identifier

##### Returns

`string`

#### Inherited from

[`Poll`](Poll.md).[`id`](Poll.md#id)

***

### openPeriod

#### Get Signature

> **get** **openPeriod**(): `number`

Defined in: contexts/index.d.ts:645

Amount of time in seconds the poll will be active after creation

##### Returns

`number`

#### Inherited from

[`Poll`](Poll.md).[`openPeriod`](Poll.md#openperiod)

***

### options

#### Get Signature

> **get** **options**(): [`PollOption`](PollOption.md)\[]

Defined in: contexts/index.d.ts:617

List of poll options

##### Returns

[`PollOption`](PollOption.md)\[]

#### Inherited from

[`Poll`](Poll.md).[`options`](Poll.md#options)

***

### question

#### Get Signature

> **get** **question**(): `string`

Defined in: contexts/index.d.ts:611

Poll question, `1-300` characters

##### Returns

`string`

#### Inherited from

[`Poll`](Poll.md).[`question`](Poll.md#question)

***

### questionEntities

#### Get Signature

> **get** **questionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:615

*Optional*. Special entities that appear in the *question*. Currently, only custom emoji entities are allowed in poll questions

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Poll`](Poll.md).[`questionEntities`](Poll.md#questionentities)

***

### totalVoterCount

#### Get Signature

> **get** **totalVoterCount**(): `number`

Defined in: contexts/index.d.ts:619

Total number of users that voted in the poll

##### Returns

`number`

#### Inherited from

[`Poll`](Poll.md).[`totalVoterCount`](Poll.md#totalvotercount)

***

### type

#### Get Signature

> **get** **type**(): [`TelegramPollType`](../../../../gramio/type-aliases/TelegramPollType.md)

Defined in: contexts/index.d.ts:625

Poll type, currently can be `regular` or `quiz`

##### Returns

[`TelegramPollType`](../../../../gramio/type-aliases/TelegramPollType.md)

#### Inherited from

[`Poll`](Poll.md).[`type`](Poll.md#type)

## Methods

### isAnonymous()

> **isAnonymous**(): `boolean`

Defined in: contexts/index.d.ts:623

`true`, if the poll is anonymous

#### Returns

`boolean`

#### Inherited from

[`Poll`](Poll.md).[`isAnonymous`](Poll.md#isanonymous)

***

### isClosed()

> **isClosed**(): `boolean`

Defined in: contexts/index.d.ts:621

`true`, if the poll is closed

#### Returns

`boolean`

#### Inherited from

[`Poll`](Poll.md).[`isClosed`](Poll.md#isclosed)

---

---
url: 'https://gramio.dev/api/contexts/classes/PollContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PollContext

# Class: PollContext\<Bot>

Defined in: contexts/index.d.ts:6257

This object contains information about a poll.

[Documentation](https://core.telegram.org/bots/api/#poll)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`PollContext`<`Bot`>>.[`Poll`](Poll.md).[`CloneMixin`](CloneMixin.md)<`Bot`, `PollContext`<`Bot`>, `PollContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new PollContext**<`Bot`>(`options`): `PollContext`<`Bot`>

Defined in: contexts/index.d.ts:6260

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `PollContextOptions`<`Bot`> |

#### Returns

`PollContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new PollContext**(...`args`): `PollContext`

Defined in: contexts/index.d.ts:6257

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`PollContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramPoll`](../../../../gramio/interfaces/TelegramPoll.md) | The raw data that is used for this Context | [`Poll`](Poll.md).[`payload`](Poll.md#payload) | contexts/index.d.ts:6259 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### allowsMultipleAnswers

#### Get Signature

> **get** **allowsMultipleAnswers**(): `boolean`

Defined in: contexts/index.d.ts:627

`true`, if the poll allows multiple answers

##### Returns

`boolean`

#### Inherited from

[`Poll`](Poll.md).[`allowsMultipleAnswers`](Poll.md#allowsmultipleanswers)

***

### closeDate

#### Get Signature

> **get** **closeDate**(): `number`

Defined in: contexts/index.d.ts:649

Point in time (Unix timestamp) when the poll will be automatically closed

##### Returns

`number`

#### Inherited from

[`Poll`](Poll.md).[`closeDate`](Poll.md#closedate)

***

### correctOptionId

#### Get Signature

> **get** **correctOptionId**(): `number`

Defined in: contexts/index.d.ts:633

0-based identifier of the correct answer option. Available only for polls
in the quiz mode, which are closed, or was sent (not forwarded) by the bot
or to the private chat with the bot.

##### Returns

`number`

#### Inherited from

[`Poll`](Poll.md).[`correctOptionId`](Poll.md#correctoptionid)

***

### explanation

#### Get Signature

> **get** **explanation**(): `string`

Defined in: contexts/index.d.ts:638

Text that is shown when a user chooses an incorrect answer or taps on the
lamp icon in a quiz-style poll, 0-200 characters

##### Returns

`string`

#### Inherited from

[`Poll`](Poll.md).[`explanation`](Poll.md#explanation)

***

### explanationEntities

#### Get Signature

> **get** **explanationEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:643

Special entities like usernames, URLs, bot commands, etc. that appear in
the explanation

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Poll`](Poll.md).[`explanationEntities`](Poll.md#explanationentities)

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:609

Unique poll identifier

##### Returns

`string`

#### Inherited from

[`Poll`](Poll.md).[`id`](Poll.md#id)

***

### openPeriod

#### Get Signature

> **get** **openPeriod**(): `number`

Defined in: contexts/index.d.ts:645

Amount of time in seconds the poll will be active after creation

##### Returns

`number`

#### Inherited from

[`Poll`](Poll.md).[`openPeriod`](Poll.md#openperiod)

***

### options

#### Get Signature

> **get** **options**(): [`PollOption`](PollOption.md)\[]

Defined in: contexts/index.d.ts:617

List of poll options

##### Returns

[`PollOption`](PollOption.md)\[]

#### Inherited from

[`Poll`](Poll.md).[`options`](Poll.md#options)

***

### question

#### Get Signature

> **get** **question**(): `string`

Defined in: contexts/index.d.ts:611

Poll question, `1-300` characters

##### Returns

`string`

#### Inherited from

[`Poll`](Poll.md).[`question`](Poll.md#question)

***

### questionEntities

#### Get Signature

> **get** **questionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:615

*Optional*. Special entities that appear in the *question*. Currently, only custom emoji entities are allowed in poll questions

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Poll`](Poll.md).[`questionEntities`](Poll.md#questionentities)

***

### totalVoterCount

#### Get Signature

> **get** **totalVoterCount**(): `number`

Defined in: contexts/index.d.ts:619

Total number of users that voted in the poll

##### Returns

`number`

#### Inherited from

[`Poll`](Poll.md).[`totalVoterCount`](Poll.md#totalvotercount)

***

### type

#### Get Signature

> **get** **type**(): [`TelegramPollType`](../../../../gramio/type-aliases/TelegramPollType.md)

Defined in: contexts/index.d.ts:625

Poll type, currently can be `regular` or `quiz`

##### Returns

[`TelegramPollType`](../../../../gramio/type-aliases/TelegramPollType.md)

#### Inherited from

[`Poll`](Poll.md).[`type`](Poll.md#type)

## Methods

### clone()

> **clone**(`options?`): `PollContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `PollContextOptions` |

#### Returns

`PollContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### hasCloseDate()

> **hasCloseDate**(): `this is Require<PollContext<Bot>, "closeDate">`

Defined in: contexts/index.d.ts:6274

Checks if poll has `closeDate` property

#### Returns

`this is Require<PollContext<Bot>, "closeDate">`

***

### hasCorrectOptionId()

> **hasCorrectOptionId**(): `this is Require<PollContext<Bot>, "correctOptionId">`

Defined in: contexts/index.d.ts:6266

Checks if poll has `correctOptionId` property

#### Returns

`this is Require<PollContext<Bot>, "correctOptionId">`

***

### hasExplanation()

> **hasExplanation**(): `this is Require<PollContext<Bot>, "explanation">`

Defined in: contexts/index.d.ts:6268

Checks if poll has `explanation` property

#### Returns

`this is Require<PollContext<Bot>, "explanation">`

***

### hasExplanationEntities()

> **hasExplanationEntities**(): `this is Require<PollContext<Bot>, "explanationEntities">`

Defined in: contexts/index.d.ts:6270

Checks if poll has `explanationEntities` property

#### Returns

`this is Require<PollContext<Bot>, "explanationEntities">`

***

### hasOpenPeriod()

> **hasOpenPeriod**(): `this is Require<PollContext<Bot>, "openPeriod">`

Defined in: contexts/index.d.ts:6272

Checks if poll has `openPeriod` property

#### Returns

`this is Require<PollContext<Bot>, "openPeriod">`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAnonymous()

> **isAnonymous**(): `boolean`

Defined in: contexts/index.d.ts:623

`true`, if the poll is anonymous

#### Returns

`boolean`

#### Inherited from

[`Poll`](Poll.md).[`isAnonymous`](Poll.md#isanonymous)

***

### isClosed()

> **isClosed**(): `boolean`

Defined in: contexts/index.d.ts:621

`true`, if the poll is closed

#### Returns

`boolean`

#### Inherited from

[`Poll`](Poll.md).[`isClosed`](Poll.md#isclosed)

***

### isQuiz()

> **isQuiz**(): `this is RequireValue<PollContext<Bot>, "type", Quiz>`

Defined in: contexts/index.d.ts:6264

Returns `true` if current poll is a quiz

#### Returns

`this is RequireValue<PollContext<Bot>, "type", Quiz>`

***

### isRegular()

> **isRegular**(): `this is RequireValue<PollContext<Bot>, "type", Regular>`

Defined in: contexts/index.d.ts:6262

Returns `true` if current poll is a regular one

#### Returns

`this is RequireValue<PollContext<Bot>, "type", Regular>`

---

---
url: 'https://gramio.dev/api/contexts/classes/PollOption.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PollOption

# Class: PollOption

Defined in: contexts/index.d.ts:583

This object contains information about one answer option in a poll.

[Documentation](https://core.telegram.org/bots/api/#polloption)

## Constructors

### Constructor

> **new PollOption**(`payload`): `PollOption`

Defined in: contexts/index.d.ts:585

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramPollOption`](../../../../gramio/interfaces/TelegramPollOption.md) |

#### Returns

`PollOption`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramPollOption`](../../../../gramio/interfaces/TelegramPollOption.md) | contexts/index.d.ts:584 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:587

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:591

Option text, 1-100 characters

##### Returns

`string`

***

### textEntities

#### Get Signature

> **get** **textEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:595

*Optional*. Special entities that appear in the option *text*. Currently, only custom emoji entities are allowed in poll option texts

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

***

### voterCount

#### Get Signature

> **get** **voterCount**(): `number`

Defined in: contexts/index.d.ts:599

Number of users that voted for this option

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/PreCheckoutQuery.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PreCheckoutQuery

# Class: PreCheckoutQuery

Defined in: contexts/index.d.ts:4382

This object contains information about an incoming pre-checkout query.

## Extended by

* [`PreCheckoutQueryContext`](PreCheckoutQueryContext.md)

## Constructors

### Constructor

> **new PreCheckoutQuery**(`payload`): `PreCheckoutQuery`

Defined in: contexts/index.d.ts:4384

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramPreCheckoutQuery`](../../../../gramio/interfaces/TelegramPreCheckoutQuery.md) |

#### Returns

`PreCheckoutQuery`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramPreCheckoutQuery`](../../../../gramio/interfaces/TelegramPreCheckoutQuery.md) | contexts/index.d.ts:4383 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4386

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### currency

#### Get Signature

> **get** **currency**(): [`TelegramCurrencies`](../../../../gramio/type-aliases/TelegramCurrencies.md)

Defined in: contexts/index.d.ts:4394

Three-letter ISO 4217 currency code

##### Returns

[`TelegramCurrencies`](../../../../gramio/type-aliases/TelegramCurrencies.md)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4390

User who sent the query

##### Returns

[`User`](User.md)

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:4388

Unique query identifier

##### Returns

`string`

***

### invoicePayload

#### Get Signature

> **get** **invoicePayload**(): `string`

Defined in: contexts/index.d.ts:4405

Bot specified invoice payload

##### Returns

`string`

***

### orderInfo

#### Get Signature

> **get** **orderInfo**(): [`OrderInfo`](OrderInfo.md)

Defined in: contexts/index.d.ts:4409

Order info provided by the user

##### Returns

[`OrderInfo`](OrderInfo.md)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4392

Sender ID

##### Returns

`number`

***

### shippingOptionId

#### Get Signature

> **get** **shippingOptionId**(): `string`

Defined in: contexts/index.d.ts:4407

Identifier of the shipping option chosen by the user

##### Returns

`string`

***

### totalAmount

#### Get Signature

> **get** **totalAmount**(): `number`

Defined in: contexts/index.d.ts:4403

Total price in the smallest units of the currency
(integer, not float/double). For example, for a price of
`US$ 1.45` pass `amount = 145`. See the `exp` parameter in
[currencies.json](https://core.telegram.org/bots/payments/currencies.json),
it shows the number of digits past the decimal point for each currency
(2 for the majority of currencies).

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/PreCheckoutQueryContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PreCheckoutQueryContext

# Class: PreCheckoutQueryContext\<Bot>

Defined in: contexts/index.d.ts:6290

This object contains information about an incoming pre-checkout query.

[Documentation](https://core.telegram.org/bots/api/#precheckoutquery)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`PreCheckoutQueryContext`<`Bot`>>.[`PreCheckoutQuery`](PreCheckoutQuery.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `PreCheckoutQueryContext`<`Bot`>, `PreCheckoutQueryContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new PreCheckoutQueryContext**<`Bot`>(`options`): `PreCheckoutQueryContext`<`Bot`>

Defined in: contexts/index.d.ts:6293

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `PreCheckoutQueryContextOptions`<`Bot`> |

#### Returns

`PreCheckoutQueryContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new PreCheckoutQueryContext**(...`args`): `PreCheckoutQueryContext`

Defined in: contexts/index.d.ts:6290

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`PreCheckoutQueryContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | [`TelegramPreCheckoutQuery`](../../../../gramio/interfaces/TelegramPreCheckoutQuery.md) | The raw data that is used for this Context | [`PreCheckoutQuery`](PreCheckoutQuery.md).[`payload`](PreCheckoutQuery.md#payload) | contexts/index.d.ts:6292 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4859

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### currency

#### Get Signature

> **get** **currency**(): [`TelegramCurrencies`](../../../../gramio/type-aliases/TelegramCurrencies.md)

Defined in: contexts/index.d.ts:4394

Three-letter ISO 4217 currency code

##### Returns

[`TelegramCurrencies`](../../../../gramio/type-aliases/TelegramCurrencies.md)

#### Inherited from

[`PreCheckoutQuery`](PreCheckoutQuery.md).[`currency`](PreCheckoutQuery.md#currency)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4390

User who sent the query

##### Returns

[`User`](User.md)

#### Inherited from

[`PreCheckoutQuery`](PreCheckoutQuery.md).[`from`](PreCheckoutQuery.md#from)

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:4388

Unique query identifier

##### Returns

`string`

#### Inherited from

[`PreCheckoutQuery`](PreCheckoutQuery.md).[`id`](PreCheckoutQuery.md#id)

***

### invoicePayload

#### Get Signature

> **get** **invoicePayload**(): `string`

Defined in: contexts/index.d.ts:4405

Bot specified invoice payload

##### Returns

`string`

#### Inherited from

[`PreCheckoutQuery`](PreCheckoutQuery.md).[`invoicePayload`](PreCheckoutQuery.md#invoicepayload)

***

### orderInfo

#### Get Signature

> **get** **orderInfo**(): [`OrderInfo`](OrderInfo.md)

Defined in: contexts/index.d.ts:4409

Order info provided by the user

##### Returns

[`OrderInfo`](OrderInfo.md)

#### Inherited from

[`PreCheckoutQuery`](PreCheckoutQuery.md).[`orderInfo`](PreCheckoutQuery.md#orderinfo)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4392

Sender ID

##### Returns

`number`

#### Inherited from

[`PreCheckoutQuery`](PreCheckoutQuery.md).[`senderId`](PreCheckoutQuery.md#senderid)

***

### shippingOptionId

#### Get Signature

> **get** **shippingOptionId**(): `string`

Defined in: contexts/index.d.ts:4407

Identifier of the shipping option chosen by the user

##### Returns

`string`

#### Inherited from

[`PreCheckoutQuery`](PreCheckoutQuery.md).[`shippingOptionId`](PreCheckoutQuery.md#shippingoptionid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

***

### totalAmount

#### Get Signature

> **get** **totalAmount**(): `number`

Defined in: contexts/index.d.ts:4403

Total price in the smallest units of the currency
(integer, not float/double). For example, for a price of
`US$ 1.45` pass `amount = 145`. See the `exp` parameter in
[currencies.json](https://core.telegram.org/bots/payments/currencies.json),
it shows the number of digits past the decimal point for each currency
(2 for the majority of currencies).

##### Returns

`number`

#### Inherited from

[`PreCheckoutQuery`](PreCheckoutQuery.md).[`totalAmount`](PreCheckoutQuery.md#totalamount)

## Methods

### answer()

> **answer**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:6301

Answers to the pending pre-checkout query. An alias for `answerPreCheckoutQuery`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`AnswerPreCheckoutQueryParams`](../../../../gramio/interfaces/AnswerPreCheckoutQueryParams.md), `"pre_checkout_query_id"`> |

#### Returns

`Promise`<`true`>

***

### answerPreCheckoutQuery()

> **answerPreCheckoutQuery**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:6299

Answers to the pending pre-checkout query

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`AnswerPreCheckoutQueryParams`](../../../../gramio/interfaces/AnswerPreCheckoutQueryParams.md), `"pre_checkout_query_id"`> |

#### Returns

`Promise`<`true`>

***

### clone()

> **clone**(`options?`): `PreCheckoutQueryContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `PreCheckoutQueryContextOptions` |

#### Returns

`PreCheckoutQueryContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasOrderInfo()

> **hasOrderInfo**(): `this is Require<PreCheckoutQueryContext<Bot>, "orderInfo">`

Defined in: contexts/index.d.ts:6297

Checks if the query has `orderInfo` property

#### Returns

`this is Require<PreCheckoutQueryContext<Bot>, "orderInfo">`

***

### hasShippingOptionId()

> **hasShippingOptionId**(): `this is Require<PreCheckoutQueryContext<Bot>, "shippingOptionId">`

Defined in: contexts/index.d.ts:6295

Checks if the query has `shippingOptionId` property

#### Returns

`this is Require<PreCheckoutQueryContext<Bot>, "shippingOptionId">`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ProximityAlertTriggered.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ProximityAlertTriggered

# Class: ProximityAlertTriggered

Defined in: contexts/index.d.ts:2204

This object represents the content of a service message,
sent whenever a user in the chat triggers a proximity alert set by another user.

## Constructors

### Constructor

> **new ProximityAlertTriggered**(`payload`): `ProximityAlertTriggered`

Defined in: contexts/index.d.ts:2206

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramProximityAlertTriggered`](../../../../gramio/interfaces/TelegramProximityAlertTriggered.md) |

#### Returns

`ProximityAlertTriggered`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramProximityAlertTriggered`](../../../../gramio/interfaces/TelegramProximityAlertTriggered.md) | contexts/index.d.ts:2205 |

## Accessors

### distance

#### Get Signature

> **get** **distance**(): `number`

Defined in: contexts/index.d.ts:2212

The distance between the users

##### Returns

`number`

***

### traveler

#### Get Signature

> **get** **traveler**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2208

User that triggered the alert

##### Returns

[`User`](User.md)

***

### watcher

#### Get Signature

> **get** **watcher**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2210

User that set the alert

##### Returns

[`User`](User.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/ProximityAlertTriggeredContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ProximityAlertTriggeredContext

# Class: ProximityAlertTriggeredContext\<Bot>

Defined in: contexts/index.d.ts:6317

This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

[Documentation](https://core.telegram.org/bots/api/#proximityalerttriggered)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ProximityAlertTriggeredContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ProximityAlertTriggeredContext`<`Bot`>, `ProximityAlertTriggeredContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ProximityAlertTriggeredContext**<`Bot`>(`options`): `ProximityAlertTriggeredContext`<`Bot`>

Defined in: contexts/index.d.ts:6320

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ProximityAlertTriggeredContextOptions`<`Bot`> |

#### Returns

`ProximityAlertTriggeredContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ProximityAlertTriggeredContext**(...`args`): `ProximityAlertTriggeredContext`

Defined in: contexts/index.d.ts:6317

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ProximityAlertTriggeredContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6319 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlert

#### Get Signature

> **get** **proximityAlert**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:6326

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `ProximityAlertTriggeredContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ProximityAlertTriggeredContextOptions` |

#### Returns

`ProximityAlertTriggeredContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<ProximityAlertTriggeredContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ProximityAlertTriggeredContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ProximityAlertTriggeredContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ProximityAlertTriggeredContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<ProximityAlertTriggeredContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<ProximityAlertTriggeredContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<ProximityAlertTriggeredContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<ProximityAlertTriggeredContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<ProximityAlertTriggeredContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<ProximityAlertTriggeredContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<ProximityAlertTriggeredContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<ProximityAlertTriggeredContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/ReactionCount.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ReactionCount

# Class: ReactionCount

Defined in: contexts/index.d.ts:4413

Represents a reaction added to a message along with the number of times it was added.

## Constructors

### Constructor

> **new ReactionCount**(`payload`): `ReactionCount`

Defined in: contexts/index.d.ts:4415

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramReactionCount`](../../../../gramio/interfaces/TelegramReactionCount.md) |

#### Returns

`ReactionCount`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramReactionCount`](../../../../gramio/interfaces/TelegramReactionCount.md) | contexts/index.d.ts:4414 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4417

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### totalCount

#### Get Signature

> **get** **totalCount**(): `number`

Defined in: contexts/index.d.ts:4421

Number of times the reaction was added

##### Returns

`number`

***

### type

#### Get Signature

> **get** **type**(): [`ReactionTypeEmoji`](ReactionTypeEmoji.md) | [`ReactionTypeCustomEmoji`](ReactionTypeCustomEmoji.md)

Defined in: contexts/index.d.ts:4419

Type of the reaction

##### Returns

[`ReactionTypeEmoji`](ReactionTypeEmoji.md) | [`ReactionTypeCustomEmoji`](ReactionTypeCustomEmoji.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/ReactionTypeCustomEmoji.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ReactionTypeCustomEmoji

# Class: ReactionTypeCustomEmoji

Defined in: contexts/index.d.ts:4258

The reaction is based on a custom emoji.

[Documentation](https://core.telegram.org/bots/api/#reactiontypecustomemoji)

## Extends

* `ReactionType`

## Constructors

### Constructor

> **new ReactionTypeCustomEmoji**(`payload`): `ReactionTypeCustomEmoji`

Defined in: contexts/index.d.ts:4260

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramReactionTypeCustomEmoji`](../../../../gramio/interfaces/TelegramReactionTypeCustomEmoji.md) |

#### Returns

`ReactionTypeCustomEmoji`

#### Overrides

`ReactionType.constructor`

## Properties

| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
|  `payload` | [`TelegramReactionTypeCustomEmoji`](../../../../gramio/interfaces/TelegramReactionTypeCustomEmoji.md) | `ReactionType.payload` | contexts/index.d.ts:4259 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4302

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

`ReactionType.[toStringTag]`

***

### customEmoji

#### Get Signature

> **get** **customEmoji**(): `string`

Defined in: contexts/index.d.ts:4264

Custom emoji identifier

##### Returns

`string`

***

### type

#### Get Signature

> **get** **type**(): `"custom_emoji"`

Defined in: contexts/index.d.ts:4262

Type of the reaction, always `custom_emoji`

##### Returns

`"custom_emoji"`

## Methods

### is()

> **is**<`T`>(`type`): `this is ReactionTypeMapping[T]`

Defined in: contexts/index.d.ts:4304

Is this reaction type the same as the `type`?

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `"custom_emoji"` | `"emoji"` | `"paid"` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | `T` |

#### Returns

`this is ReactionTypeMapping[T]`

#### Inherited from

`ReactionType.is`

---

---
url: 'https://gramio.dev/api/contexts/classes/ReactionTypeEmoji.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ReactionTypeEmoji

# Class: ReactionTypeEmoji

Defined in: contexts/index.d.ts:4272

The reaction is based on an emoji.

[Documentation](https://core.telegram.org/bots/api/#reactiontypeemoji)

## Extends

* `ReactionType`

## Constructors

### Constructor

> **new ReactionTypeEmoji**(`payload`): `ReactionTypeEmoji`

Defined in: contexts/index.d.ts:4274

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramReactionTypeEmoji`](../../../../gramio/interfaces/TelegramReactionTypeEmoji.md) |

#### Returns

`ReactionTypeEmoji`

#### Overrides

`ReactionType.constructor`

## Properties

| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
|  `payload` | [`TelegramReactionTypeEmoji`](../../../../gramio/interfaces/TelegramReactionTypeEmoji.md) | `ReactionType.payload` | contexts/index.d.ts:4273 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4302

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

`ReactionType.[toStringTag]`

***

### emoji

#### Get Signature

> **get** **emoji**(): [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md)

Defined in: contexts/index.d.ts:4278

Reaction emoji. Currently, it can be one of "👍", "👎", "❤", "🔥", "🥰", "👏", "😁", "🤔", "🤯", "😱", "🤬", "😢", "🎉", "🤩", "🤮", "💩", "🙏", "👌", "🕊", "🤡", "🥱", "🥴", "😍", "🐳", "❤‍🔥", "🌚", "🌭", "💯", "🤣", "⚡", "🍌", "🏆", "💔", "🤨", "😐", "🍓", "🍾", "💋", "🖕", "😈", "😴", "😭", "🤓", "👻", "👨‍💻", "👀", "🎃", "🙈", "😇", "😨", "🤝", "✍", "🤗", "🫡", "🎅", "🎄", "☃", "💅", "🤪", "🗿", "🆒", "💘", "🙉", "🦄", "😘", "💊", "🙊", "😎", "👾", "🤷‍♂", "🤷", "🤷‍♀", "😡"

##### Returns

[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md)

***

### type

#### Get Signature

> **get** **type**(): `"emoji"`

Defined in: contexts/index.d.ts:4276

Type of the reaction, always `emoji`

##### Returns

`"emoji"`

## Methods

### is()

> **is**<`T`>(`type`): `this is ReactionTypeMapping[T]`

Defined in: contexts/index.d.ts:4304

Is this reaction type the same as the `type`?

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `"custom_emoji"` | `"emoji"` | `"paid"` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | `T` |

#### Returns

`this is ReactionTypeMapping[T]`

#### Inherited from

`ReactionType.is`

---

---
url: 'https://gramio.dev/api/contexts/classes/ReactionTypePaid.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ReactionTypePaid

# Class: ReactionTypePaid

Defined in: contexts/index.d.ts:4286

The reaction is paid.

[Documentation](https://core.telegram.org/bots/api#reactiontypepaid)

## Extends

* `ReactionType`

## Constructors

### Constructor

> **new ReactionTypePaid**(`payload`): `ReactionTypePaid`

Defined in: contexts/index.d.ts:4288

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramReactionTypePaid`](../../../../gramio/interfaces/TelegramReactionTypePaid.md) |

#### Returns

`ReactionTypePaid`

#### Overrides

`ReactionType.constructor`

## Properties

| Property | Type | Overrides | Defined in |
| ------ | ------ | ------ | ------ |
|  `payload` | [`TelegramReactionTypePaid`](../../../../gramio/interfaces/TelegramReactionTypePaid.md) | `ReactionType.payload` | contexts/index.d.ts:4287 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4302

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

`ReactionType.[toStringTag]`

***

### type

#### Get Signature

> **get** **type**(): `"paid"`

Defined in: contexts/index.d.ts:4290

Type of the reaction, always `emoji`

##### Returns

`"paid"`

## Methods

### is()

> **is**<`T`>(`type`): `this is ReactionTypeMapping[T]`

Defined in: contexts/index.d.ts:4304

Is this reaction type the same as the `type`?

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `"custom_emoji"` | `"emoji"` | `"paid"` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | `T` |

#### Returns

`this is ReactionTypeMapping[T]`

#### Inherited from

`ReactionType.is`

---

---
url: 'https://gramio.dev/api/contexts/classes/RefundedPayment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / RefundedPayment

# Class: RefundedPayment

Defined in: contexts/index.d.ts:4429

This object contains basic information about a refunded payment.

[Documentation](https://core.telegram.org/bots/api/#refundedpayment)

## Constructors

### Constructor

> **new RefundedPayment**(`payload`): `RefundedPayment`

Defined in: contexts/index.d.ts:4431

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramRefundedPayment`](../../../../gramio/interfaces/TelegramRefundedPayment.md) |

#### Returns

`RefundedPayment`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramRefundedPayment`](../../../../gramio/interfaces/TelegramRefundedPayment.md) | contexts/index.d.ts:4430 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4432

##### Returns

`string`

***

### currency

#### Get Signature

> **get** **currency**(): [`TelegramCurrencies`](../../../../gramio/type-aliases/TelegramCurrencies.md)

Defined in: contexts/index.d.ts:4436

Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code, or “XTR” for payments in [Telegram Stars](https://t.me/BotNews/90). Currently, always “XTR”

##### Returns

[`TelegramCurrencies`](../../../../gramio/type-aliases/TelegramCurrencies.md)

***

### invoicePayload

#### Get Signature

> **get** **invoicePayload**(): `string`

Defined in: contexts/index.d.ts:4444

Bot-specified invoice payload

##### Returns

`string`

***

### providerPaymentChargeId

#### Get Signature

> **get** **providerPaymentChargeId**(): `string`

Defined in: contexts/index.d.ts:4452

*Optional*. Provider payment identifier

##### Returns

`string`

***

### telegramPaymentChargeId

#### Get Signature

> **get** **telegramPaymentChargeId**(): `string`

Defined in: contexts/index.d.ts:4448

Telegram payment identifier

##### Returns

`string`

***

### totalAmount

#### Get Signature

> **get** **totalAmount**(): `number`

Defined in: contexts/index.d.ts:4440

Total refunded price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of `US$ 1.45`, `total_amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/RefundedPaymentContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / RefundedPaymentContext

# Class: RefundedPaymentContext\<Bot>

Defined in: contexts/index.d.ts:6342

This object contains basic information about a successful payment.

[Documentation](https://core.telegram.org/bots/api/#RefundedPayment)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`RefundedPaymentContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `RefundedPaymentContext`<`Bot`>, `RefundedPaymentContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new RefundedPaymentContext**<`Bot`>(`options`): `RefundedPaymentContext`<`Bot`>

Defined in: contexts/index.d.ts:6345

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `RefundedPaymentContextOptions`<`Bot`> |

#### Returns

`RefundedPaymentContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new RefundedPaymentContext**(...`args`): `RefundedPaymentContext`

Defined in: contexts/index.d.ts:6342

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`RefundedPaymentContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6344 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventRefundedPayment

#### Get Signature

> **get** **eventRefundedPayment**(): [`RefundedPayment`](RefundedPayment.md)

Defined in: contexts/index.d.ts:6351

This object contains basic information about a refunded payment.

[Documentation](https://core.telegram.org/bots/api/#refundedpayment)

##### Returns

[`RefundedPayment`](RefundedPayment.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `RefundedPaymentContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `RefundedPaymentContextOptions` |

#### Returns

`RefundedPaymentContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<RefundedPaymentContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<RefundedPaymentContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<RefundedPaymentContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<RefundedPaymentContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<RefundedPaymentContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<RefundedPaymentContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<RefundedPaymentContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<RefundedPaymentContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<RefundedPaymentContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<RefundedPaymentContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<RefundedPaymentContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<RefundedPaymentContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/RemovedChatBoostContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / RemovedChatBoostContext

# Class: RemovedChatBoostContext\<Bot>

Defined in: contexts/index.d.ts:6363

This object represents a boost removed from a chat.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`RemovedChatBoostContext`<`Bot`>>.[`ChatBoostRemoved`](ChatBoostRemoved.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `RemovedChatBoostContext`<`Bot`>, `RemovedChatBoostContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new RemovedChatBoostContext**<`Bot`>(`options`): `RemovedChatBoostContext`<`Bot`>

Defined in: contexts/index.d.ts:6366

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `RemovedChatBoostContextOptions`<`Bot`> |

#### Returns

`RemovedChatBoostContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new RemovedChatBoostContext**(...`args`): `RemovedChatBoostContext`

Defined in: contexts/index.d.ts:6363

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`RemovedChatBoostContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | [`TelegramChatBoostRemoved`](../../../../gramio/interfaces/TelegramChatBoostRemoved.md) | The raw data that is used for this Context | [`ChatBoostRemoved`](ChatBoostRemoved.md).[`payload`](ChatBoostRemoved.md#payload) | contexts/index.d.ts:6365 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:3339

Chat which was boosted

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`ChatBoostRemoved`](ChatBoostRemoved.md).[`chat`](ChatBoostRemoved.md#chat)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4859

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:3341

Unique identifier of the boost

##### Returns

`string`

#### Inherited from

[`ChatBoostRemoved`](ChatBoostRemoved.md).[`id`](ChatBoostRemoved.md#id)

***

### removeDate

#### Get Signature

> **get** **removeDate**(): `number`

Defined in: contexts/index.d.ts:3343

Point in time (Unix timestamp) when the boost was removed

##### Returns

`number`

#### Inherited from

[`ChatBoostRemoved`](ChatBoostRemoved.md).[`removeDate`](ChatBoostRemoved.md#removedate)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4861

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`senderId`](SendMixin.md#senderid)

***

### source

#### Get Signature

> **get** **source**(): [`ChatBoostSourcePremium`](ChatBoostSourcePremium.md) | [`ChatBoostSourceGiftCode`](ChatBoostSourceGiftCode.md) | [`ChatBoostSourceGiveaway`](ChatBoostSourceGiveaway.md)

Defined in: contexts/index.d.ts:3345

Source of the removed boost

##### Returns

[`ChatBoostSourcePremium`](ChatBoostSourcePremium.md) | [`ChatBoostSourceGiftCode`](ChatBoostSourceGiftCode.md) | [`ChatBoostSourceGiveaway`](ChatBoostSourceGiveaway.md)

#### Inherited from

[`ChatBoostRemoved`](ChatBoostRemoved.md).[`source`](ChatBoostRemoved.md#source)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### clone()

> **clone**(`options?`): `RemovedChatBoostContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `RemovedChatBoostContextOptions` |

#### Returns

`RemovedChatBoostContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/keyboards/classes/RemoveKeyboard.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / RemoveKeyboard

# Class: RemoveKeyboard

Defined in: keyboards/index.d.ts:587

**ReplyKeyboardRemove** builder

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 (see [ReplyKeyboardMarkup](https://core.telegram.org/bots/api/#replykeyboardmarkup)).

[\[Documentation\]](https://core.telegram.org/bots/api/#replykeyboardremove)

## Constructors

### Constructor

> **new RemoveKeyboard**(): `RemoveKeyboard`

#### Returns

`RemoveKeyboard`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `options` | `object` | keyboards/index.d.ts:588 |
| `options.isSelective` | `boolean` | keyboards/index.d.ts:589 |

## Methods

### build()

> **build**(): [`TelegramReplyKeyboardRemove`](../../../../gramio/interfaces/TelegramReplyKeyboardRemove.md)

Defined in: keyboards/index.d.ts:605

Return [TelegramReplyKeyboardRemove](../../../../gramio/interfaces/TelegramReplyKeyboardRemove.md) as object

#### Returns

[`TelegramReplyKeyboardRemove`](../../../../gramio/interfaces/TelegramReplyKeyboardRemove.md)

***

### selective()

> **selective**(`isEnabled?`): `this`

Defined in: keyboards/index.d.ts:601

Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the *text* of the [Message](https://core.telegram.org/bots/api/#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.

*Example:* A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `isEnabled?` | `boolean` |

#### Returns

`this`

#### Example

```ts
new RemoveKeyboard().selective(); // to enable
new RemoveKeyboard().selective(false); // to disable
```

***

### toJSON()

> **toJSON**(): [`TelegramReplyKeyboardRemove`](../../../../gramio/interfaces/TelegramReplyKeyboardRemove.md)

Defined in: keyboards/index.d.ts:609

Serializing a class into an [TelegramReplyKeyboardRemove](../../../../gramio/interfaces/TelegramReplyKeyboardRemove.md) object (used by JSON.stringify)

#### Returns

[`TelegramReplyKeyboardRemove`](../../../../gramio/interfaces/TelegramReplyKeyboardRemove.md)

---

---
url: 'https://gramio.dev/api/scenes/classes/Scene.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / Scene

# Class: Scene\<Params, Errors, State, Derives>

Defined in: scenes/index.d.ts:213

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Params` | `never` |
| `Errors` *extends* [`ErrorDefinitions`](../../../../gramio/type-aliases/ErrorDefinitions.md) | `object` |
| `State` *extends* [`StateTypesDefault`](../type-aliases/StateTypesDefault.md) | `Record`<`string`, `never`> |
| `Derives` *extends* [`SceneDerivesDefinitions`](../type-aliases/SceneDerivesDefinitions.md)<`Params`, `State`, `any`> | [`SceneDerivesDefinitions`](../type-aliases/SceneDerivesDefinitions.md)<`Params`, `State`> |

## Constructors

### Constructor

> **new Scene**<`Params`, `Errors`, `State`, `Derives`>(`name`): `Scene`<`Params`, `Errors`, `State`, `Derives`>

Defined in: scenes/index.d.ts:429

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |

#### Returns

`Scene`<`Params`, `Errors`, `State`, `Derives`>

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `~` | `object` | **`Internal`** | scenes/index.d.ts:215 |
| `~.composer` | [`EventComposer`](../../../composer/dist/interfaces/EventComposer.md)<[`Context`](../../../contexts/dist/classes/Context.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>, { `boost_added`: [`BoostAddedContext`](../../../contexts/dist/classes/BoostAddedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `business_connection`: [`BusinessConnectionContext`](../../../contexts/dist/classes/BusinessConnectionContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `business_message`: [`MessageContext`](../../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `callback_query`: [`CallbackQueryContext`](../../../contexts/dist/classes/CallbackQueryContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `channel_post`: [`MessageContext`](../../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `chat_background_set`: [`ChatBackgroundSetContext`](../../../contexts/dist/classes/ChatBackgroundSetContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `chat_boost`: [`ChatBoostContext`](../../../contexts/dist/classes/ChatBoostContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `chat_join_request`: [`ChatJoinRequestContext`](../../../contexts/dist/classes/ChatJoinRequestContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `chat_member`: [`ChatMemberContext`](../../../contexts/dist/classes/ChatMemberContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `chat_owner_changed`: [`ChatOwnerChangedContext`](../../../contexts/dist/classes/ChatOwnerChangedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `chat_owner_left`: [`ChatOwnerLeftContext`](../../../contexts/dist/classes/ChatOwnerLeftContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `chat_shared`: [`ChatSharedContext`](../../../contexts/dist/classes/ChatSharedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `checklist_tasks_added`: [`ChecklistTasksAddedContext`](../../../contexts/dist/classes/ChecklistTasksAddedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `checklist_tasks_done`: [`ChecklistTasksDoneContext`](../../../contexts/dist/classes/ChecklistTasksDoneContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `chosen_inline_result`: [`ChosenInlineResultContext`](../../../contexts/dist/classes/ChosenInlineResultContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `delete_chat_photo`: [`DeleteChatPhotoContext`](../../../contexts/dist/classes/DeleteChatPhotoContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `deleted_business_messages`: [`BusinessMessagesDeletedContext`](../../../contexts/dist/classes/BusinessMessagesDeletedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `direct_message_price_changed`: [`DirectMessagePriceChangedContext`](../../../contexts/dist/classes/DirectMessagePriceChangedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `edited_business_message`: [`MessageContext`](../../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `edited_channel_post`: [`MessageContext`](../../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `edited_message`: [`MessageContext`](../../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `forum_topic_closed`: [`ForumTopicClosedContext`](../../../contexts/dist/classes/ForumTopicClosedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `forum_topic_created`: [`ForumTopicCreatedContext`](../../../contexts/dist/classes/ForumTopicCreatedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `forum_topic_edited`: [`ForumTopicEditedContext`](../../../contexts/dist/classes/ForumTopicEditedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `forum_topic_reopened`: [`ForumTopicReopenedContext`](../../../contexts/dist/classes/ForumTopicReopenedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `general_forum_topic_hidden`: [`GeneralForumTopicHiddenContext`](../../../contexts/dist/classes/GeneralForumTopicHiddenContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `general_forum_topic_unhidden`: [`GeneralForumTopicUnhiddenContext`](../../../contexts/dist/classes/GeneralForumTopicUnhiddenContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `gift`: [`GiftContext`](../../../contexts/dist/classes/GiftContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `gift_upgrade_sent`: [`GiftUpgradeSentContext`](../../../contexts/dist/classes/GiftUpgradeSentContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `giveaway_completed`: [`GiveawayCompletedContext`](../../../contexts/dist/classes/GiveawayCompletedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `giveaway_created`: [`GiveawayCreatedContext`](../../../contexts/dist/classes/GiveawayCreatedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `giveaway_winners`: [`GiveawayWinnersContext`](../../../contexts/dist/classes/GiveawayWinnersContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `group_chat_created`: [`GroupChatCreatedContext`](../../../contexts/dist/classes/GroupChatCreatedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `inline_query`: [`InlineQueryContext`](../../../contexts/dist/classes/InlineQueryContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `invoice`: [`InvoiceContext`](../../../contexts/dist/classes/InvoiceContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `left_chat_member`: [`LeftChatMemberContext`](../../../contexts/dist/classes/LeftChatMemberContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `location`: [`LocationContext`](../../../contexts/dist/classes/LocationContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `message`: [`MessageContext`](../../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)> & [`Require`](../../../contexts/dist/type-aliases/Require.md)<[`MessageContext`](../../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>, `"from"`>; `message_auto_delete_timer_changed`: [`MessageAutoDeleteTimerChangedContext`](../../../contexts/dist/classes/MessageAutoDeleteTimerChangedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `message_reaction`: [`MessageReactionContext`](../../../contexts/dist/classes/MessageReactionContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `message_reaction_count`: [`MessageReactionCountContext`](../../../contexts/dist/classes/MessageReactionCountContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `migrate_from_chat_id`: [`MigrateFromChatIdContext`](../../../contexts/dist/classes/MigrateFromChatIdContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `migrate_to_chat_id`: [`MigrateToChatIdContext`](../../../contexts/dist/classes/MigrateToChatIdContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `my_chat_member`: [`ChatMemberContext`](../../../contexts/dist/classes/ChatMemberContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `new_chat_members`: [`NewChatMembersContext`](../../../contexts/dist/classes/NewChatMembersContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `new_chat_photo`: [`NewChatPhotoContext`](../../../contexts/dist/classes/NewChatPhotoContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `new_chat_title`: [`NewChatTitleContext`](../../../contexts/dist/classes/NewChatTitleContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `paid_message_price_changed`: [`PaidMessagePriceChangedContext`](../../../contexts/dist/classes/PaidMessagePriceChangedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `passport_data`: [`PassportDataContext`](../../../contexts/dist/classes/PassportDataContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `pinned_message`: [`PinnedMessageContext`](../../../contexts/dist/classes/PinnedMessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `poll`: [`PollContext`](../../../contexts/dist/classes/PollContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `poll_answer`: [`PollAnswerContext`](../../../contexts/dist/classes/PollAnswerContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `pre_checkout_query`: [`PreCheckoutQueryContext`](../../../contexts/dist/classes/PreCheckoutQueryContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `proximity_alert_triggered`: [`ProximityAlertTriggeredContext`](../../../contexts/dist/classes/ProximityAlertTriggeredContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `purchased_paid_media`: [`PaidMediaPurchasedContext`](../../../contexts/dist/classes/PaidMediaPurchasedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `refunded_payment`: [`RefundedPaymentContext`](../../../contexts/dist/classes/RefundedPaymentContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `removed_chat_boost`: [`RemovedChatBoostContext`](../../../contexts/dist/classes/RemovedChatBoostContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `service_message`: [`MessageContext`](../../../contexts/dist/classes/MessageContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `shipping_query`: [`ShippingQueryContext`](../../../contexts/dist/classes/ShippingQueryContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `successful_payment`: [`SuccessfulPaymentContext`](../../../contexts/dist/classes/SuccessfulPaymentContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_approval_failed`: [`SuggestedPostApprovalFailedContext`](../../../contexts/dist/classes/SuggestedPostApprovalFailedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_approved`: [`SuggestedPostApprovedContext`](../../../contexts/dist/classes/SuggestedPostApprovedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_declined`: [`SuggestedPostDeclinedContext`](../../../contexts/dist/classes/SuggestedPostDeclinedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_paid`: [`SuggestedPostPaidContext`](../../../contexts/dist/classes/SuggestedPostPaidContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `suggested_post_refunded`: [`SuggestedPostRefundedContext`](../../../contexts/dist/classes/SuggestedPostRefundedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `unique_gift`: [`UniqueGiftContext`](../../../contexts/dist/classes/UniqueGiftContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `users_shared`: [`UsersSharedContext`](../../../contexts/dist/classes/UsersSharedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `video_chat_ended`: [`VideoChatEndedContext`](../../../contexts/dist/classes/VideoChatEndedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `video_chat_participants_invited`: [`VideoChatParticipantsInvitedContext`](../../../contexts/dist/classes/VideoChatParticipantsInvitedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `video_chat_scheduled`: [`VideoChatScheduledContext`](../../../contexts/dist/classes/VideoChatScheduledContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `video_chat_started`: [`VideoChatStartedContext`](../../../contexts/dist/classes/VideoChatStartedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `web_app_data`: [`WebAppDataContext`](../../../contexts/dist/classes/WebAppDataContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; `write_access_allowed`: [`WriteAccessAllowedContext`](../../../contexts/dist/classes/WriteAccessAllowedContext.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>; }, [`Context`](../../../contexts/dist/classes/Context.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>, [`Context`](../../../contexts/dist/classes/Context.md)<[`AnyBot`](../../../../gramio/type-aliases/AnyBot.md)>, { }, { }, { `callbackQuery`: `TThis`; `chosenInlineResult`: `TThis`; `command`: `TThis`; `hears`: `TThis`; `inlineQuery`: `TThis`; `reaction`: `TThis`; `startParameter`: `TThis`; }, { }> & `object` | - | scenes/index.d.ts:218 |
| `~.enter` | (`ctx`) => `void` | - | scenes/index.d.ts:425 |
| `~.params` | `Params` | - | scenes/index.d.ts:216 |
| `~.state` | `State` | - | scenes/index.d.ts:217 |
|  `name` | `string` | - | scenes/index.d.ts:427 |
|  `stepsCount` | `number` | - | scenes/index.d.ts:428 |

## Methods

### ask()

> **ask**<`Key`, `Schema`, `Return`>(`key`, `validator`, `firstTimeMessage`, `options?`): `Scene`<`Params`, `Errors`, `Record`<`string`, `never`> *extends* `State` ? `Return` : `State` & `Return`, [`Modify`](../type-aliases/Modify.md)<`Derives`, { `global`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`], { `scene`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`]\[`"scene"`], { `state`: `Record`<`string`, `never`> *extends* `State` ? `Return` : `State` & `Return`; }>; }>; }>>

Defined in: scenes/index.d.ts:466

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Key` *extends* `string` | - |
| `Schema` *extends* `StandardSchemaV1`<`unknown`, `unknown`> | - |
| `Return` *extends* [`StateTypesDefault`](../type-aliases/StateTypesDefault.md) | `{ [key in string]: InferOutput<Schema> }` |

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key` | `Key` | - |
| `validator` | `Schema` | - |
| `firstTimeMessage` | [`Stringable`](../../../../gramio/type-aliases/Stringable.md) | - |
| `options?` | { `onInvalidInput?`: (`issues`) => [`Stringable`](../../../../gramio/type-aliases/Stringable.md); } | - |
| `options.onInvalidInput?` | (`issues`) => [`Stringable`](../../../../gramio/type-aliases/Stringable.md) | Custom message when validation fails. Receives all issues from the validator. |

#### Returns

`Scene`<`Params`, `Errors`, `Record`<`string`, `never`> *extends* `State` ? `Return` : `State` & `Return`, [`Modify`](../type-aliases/Modify.md)<`Derives`, { `global`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`], { `scene`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`]\[`"scene"`], { `state`: `Record`<`string`, `never`> *extends* `State` ? `Return` : `State` & `Return`; }>; }>; }>>

***

### compose()

> **compose**(`context`, `onNext?`): `Promise`<`void`>

Defined in: scenes/index.d.ts:478

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`Context`](../../../contexts/dist/classes/Context.md)<[`Bot`](../../../../gramio/classes/Bot.md)<{ }, [`DeriveDefinitions`](../../../../gramio/type-aliases/DeriveDefinitions.md), { }>> & `object` |
| `onNext?` | () => `unknown` |

#### Returns

`Promise`<`void`>

***

### exitData()

> **exitData**<`ExitData`>(): `Scene`<`Params`, `Errors`, `State`, [`Modify`](../type-aliases/Modify.md)<`Derives`, { `global`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`], { `scene`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`]\[`"scene"`], { `exitSub`: (`returnData?`) => `Promise`<`void`>; }>; }>; }>>

Defined in: scenes/index.d.ts:444

#### Type Parameters

| Type Parameter |
| ------ |
| `ExitData` *extends* `Record`<`string`, `unknown`> |

#### Returns

`Scene`<`Params`, `Errors`, `State`, [`Modify`](../type-aliases/Modify.md)<`Derives`, { `global`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`], { `scene`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`]\[`"scene"`], { `exitSub`: (`returnData?`) => `Promise`<`void`>; }>; }>; }>>

***

### extend()

#### Call Signature

> **extend**<`UExposed`, `UDerives`>(`composer`): `Scene`<`Params`, `Errors`, `State`, `Derives` & `object` & `UDerives`>

Defined in: scenes/index.d.ts:451

##### Type Parameters

| Type Parameter |
| ------ |
| `UExposed` *extends* `object` |
| `UDerives` *extends* `Record`<`string`, `object`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `composer` | [`EventComposer`](../../../composer/dist/interfaces/EventComposer.md)<`any`, `any`, `any`, `any`, `UExposed`, `UDerives`, `any`> |

##### Returns

`Scene`<`Params`, `Errors`, `State`, `Derives` & `object` & `UDerives`>

#### Call Signature

> **extend**<`NewPlugin`>(`plugin`): `Scene`<`Params`, `Errors` & `NewPlugin`\[`"_"`]\[`"Errors"`], `State`, `Derives` & `NewPlugin`\[`"_"`]\[`"Derives"`]>

Defined in: scenes/index.d.ts:454

##### Type Parameters

| Type Parameter |
| ------ |
| `NewPlugin` *extends* [`AnyPlugin`](../../../../gramio/type-aliases/AnyPlugin.md) |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `plugin` | `NewPlugin` |

##### Returns

`Scene`<`Params`, `Errors` & `NewPlugin`\[`"_"`]\[`"Errors"`], `State`, `Derives` & `NewPlugin`\[`"_"`]\[`"Derives"`]>

***

### on()

> **on**<`T`>(`updateName`, `handler`): `this`

Defined in: scenes/index.d.ts:456

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../../../contexts/dist/type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `updateName` | [`MaybeArray`](../../../contexts/dist/type-aliases/MaybeArray.md)<`T`> |
| `handler` | [`Handler`](../../../../gramio/type-aliases/Handler.md)<`InstanceType`<[`ContextsMapping`](../../../contexts/dist/type-aliases/ContextsMapping.md)<[`Bot`](../../../../gramio/classes/Bot.md)<{ }, [`DeriveDefinitions`](../../../../gramio/type-aliases/DeriveDefinitions.md), { }>>\[`T`]> & `object` & [`DeriveDefinitions`](../../../../gramio/type-aliases/DeriveDefinitions.md)\[`T`] & `Derives`\[`"global"`] & `Derives`\[`T`]> |

#### Returns

`this`

***

### onEnter()

> **onEnter**(`handler`): `this`

Defined in: scenes/index.d.ts:455

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | (`context`) => `unknown` |

#### Returns

`this`

***

### params()

> **params**<`SceneParams`>(): `Scene`<`SceneParams`, `Errors`, `State`, [`Modify`](../type-aliases/Modify.md)<`Derives`, { `global`: { `scene`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`]\[`"scene"`], { `params`: `SceneParams`; }>; }; }>>

Defined in: scenes/index.d.ts:430

#### Type Parameters

| Type Parameter |
| ------ |
| `SceneParams` |

#### Returns

`Scene`<`SceneParams`, `Errors`, `State`, [`Modify`](../type-aliases/Modify.md)<`Derives`, { `global`: { `scene`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`]\[`"scene"`], { `params`: `SceneParams`; }>; }; }>>

***

### run()

> **run**(`context`, `storage`, `key`, `data`): `Promise`<`void`>

Defined in: scenes/index.d.ts:481

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`Context`](../../../contexts/dist/classes/Context.md)<[`Bot`](../../../../gramio/classes/Bot.md)<{ }, [`DeriveDefinitions`](../../../../gramio/type-aliases/DeriveDefinitions.md), { }>> & `object` |
| `storage` | [`Storage`](../../../storage/dist/interfaces/Storage.md) |
| `key` | `string` |
| `data` | [`ScenesStorageData`](../interfaces/ScenesStorageData.md)<`unknown`, `unknown`> |

#### Returns

`Promise`<`void`>

***

### state()

> **state**<`StateParams`>(): `Scene`<`Params`, `Errors`, `StateParams`, `Derives` & `object`>

Defined in: scenes/index.d.ts:437

#### Type Parameters

| Type Parameter |
| ------ |
| `StateParams` *extends* [`StateTypesDefault`](../type-aliases/StateTypesDefault.md) |

#### Returns

`Scene`<`Params`, `Errors`, `StateParams`, `Derives` & `object`>

***

### step()

#### Call Signature

> **step**<`T`, `Handler`, `Return`>(`updateName`, `handler`): `Scene`<`Params`, `Errors`, `Extract`<`Return`, [`UpdateData`](../type-aliases/UpdateData.md)<`any`>> *extends* [`UpdateData`](../type-aliases/UpdateData.md)<`Type`> ? `Record`<`string`, `never`> *extends* `State` ? `Type` : `State` & `Type` : `State`, [`Modify`](../type-aliases/Modify.md)<`Derives`, { `global`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`], { `scene`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`]\[`"scene"`], { `state`: `Extract`<`Return`, [`UpdateData`](../type-aliases/UpdateData.md)<`any`>> *extends* [`UpdateData`](../type-aliases/UpdateData.md)<`Type`> ? `Record`<`string`, `never`> *extends* `State` ? `Type` : `State` & `Type` : `State`; }>; }>; }>>

Defined in: scenes/index.d.ts:458

##### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` *extends* [`UpdateName`](../../../contexts/dist/type-aliases/UpdateName.md) | - |
| `Handler` *extends* [`StepHandler`](../type-aliases/StepHandler.md)<`InstanceType`<[`ContextsMapping`](../../../contexts/dist/type-aliases/ContextsMapping.md)<[`Bot`](../../../../gramio/classes/Bot.md)<{ }, [`DeriveDefinitions`](../../../../gramio/type-aliases/DeriveDefinitions.md), { }>>\[`T`]> & `object` & [`DeriveDefinitions`](../../../../gramio/type-aliases/DeriveDefinitions.md)\[`T`] & `Derives`\[`"global"`] & `Derives`\[`T`], `any`> | - |
| `Return` | `Awaited`<`ReturnType`<`Handler`>> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `updateName` | [`MaybeArray`](../../../contexts/dist/type-aliases/MaybeArray.md)<`T`> |
| `handler` | `Handler` |

##### Returns

`Scene`<`Params`, `Errors`, `Extract`<`Return`, [`UpdateData`](../type-aliases/UpdateData.md)<`any`>> *extends* [`UpdateData`](../type-aliases/UpdateData.md)<`Type`> ? `Record`<`string`, `never`> *extends* `State` ? `Type` : `State` & `Type` : `State`, [`Modify`](../type-aliases/Modify.md)<`Derives`, { `global`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`], { `scene`: [`Modify`](../type-aliases/Modify.md)<`Derives`\[`"global"`]\[`"scene"`], { `state`: `Extract`<`Return`, [`UpdateData`](../type-aliases/UpdateData.md)<`any`>> *extends* [`UpdateData`](../type-aliases/UpdateData.md)<`Type`> ? `Record`<`string`, `never`> *extends* `State` ? `Type` : `State` & `Type` : `State`; }>; }>; }>>

#### Call Signature

> **step**(`handler`): `this`

Defined in: scenes/index.d.ts:465

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`Handler`](../../../../gramio/type-aliases/Handler.md)<[`Context`](../../../contexts/dist/classes/Context.md)<[`Bot`](../../../../gramio/classes/Bot.md)<{ }, [`DeriveDefinitions`](../../../../gramio/type-aliases/DeriveDefinitions.md), { }>> & `Derives`\[`"global"`]> |

##### Returns

`this`

***

### use()

> **use**(`handler`): `this`

Defined in: scenes/index.d.ts:457

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`Handler`](../../../../gramio/type-aliases/Handler.md)<[`Context`](../../../contexts/dist/classes/Context.md)<[`Bot`](../../../../gramio/classes/Bot.md)<{ }, [`DeriveDefinitions`](../../../../gramio/type-aliases/DeriveDefinitions.md), { }>> & `Derives`\[`"global"`]> |

#### Returns

`this`

---

---
url: 'https://gramio.dev/api/contexts/classes/SendMixin.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SendMixin

# Class: SendMixin\<Bot>

Defined in: contexts/index.d.ts:4866

This object represents a mixin which can invoke `chatId`/`senderId`-dependent methods

## Extends

* [`Context`](Context.md)<`Bot`>.`SendMixinMetadata`

## Extended by

* [`BoostAddedContext`](BoostAddedContext.md)
* [`CallbackQueryContext`](CallbackQueryContext.md)
* [`ChatActionMixin`](ChatActionMixin.md)
* [`ChatBackgroundSetContext`](ChatBackgroundSetContext.md)
* [`ChatBoostContext`](ChatBoostContext.md)
* [`ChatJoinRequestContext`](ChatJoinRequestContext.md)
* [`ChatMemberContext`](ChatMemberContext.md)
* [`ChatOwnerChangedContext`](ChatOwnerChangedContext.md)
* [`ChatOwnerLeftContext`](ChatOwnerLeftContext.md)
* [`ChatSharedContext`](ChatSharedContext.md)
* [`ChecklistTasksAddedContext`](ChecklistTasksAddedContext.md)
* [`ChecklistTasksDoneContext`](ChecklistTasksDoneContext.md)
* [`ChosenInlineResultContext`](ChosenInlineResultContext.md)
* [`DeleteChatPhotoContext`](DeleteChatPhotoContext.md)
* [`DirectMessagePriceChangedContext`](DirectMessagePriceChangedContext.md)
* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiftContext`](GiftContext.md)
* [`GiftUpgradeSentContext`](GiftUpgradeSentContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)
* [`GroupChatCreatedContext`](GroupChatCreatedContext.md)
* [`InvoiceContext`](InvoiceContext.md)
* [`LeftChatMemberContext`](LeftChatMemberContext.md)
* [`LocationContext`](LocationContext.md)
* [`MessageAutoDeleteTimerChangedContext`](MessageAutoDeleteTimerChangedContext.md)
* [`MessageContext`](MessageContext.md)
* [`MessageReactionContext`](MessageReactionContext.md)
* [`MessageReactionCountContext`](MessageReactionCountContext.md)
* [`MigrateFromChatIdContext`](MigrateFromChatIdContext.md)
* [`MigrateToChatIdContext`](MigrateToChatIdContext.md)
* [`NewChatMembersContext`](NewChatMembersContext.md)
* [`NewChatPhotoContext`](NewChatPhotoContext.md)
* [`NewChatTitleContext`](NewChatTitleContext.md)
* [`NodeMixin`](NodeMixin.md)
* [`PaidMediaPurchasedContext`](PaidMediaPurchasedContext.md)
* [`PaidMessagePriceChangedContext`](PaidMessagePriceChangedContext.md)
* [`PassportDataContext`](PassportDataContext.md)
* [`PinnedMessageContext`](PinnedMessageContext.md)
* [`PollAnswerContext`](PollAnswerContext.md)
* [`PreCheckoutQueryContext`](PreCheckoutQueryContext.md)
* [`ProximityAlertTriggeredContext`](ProximityAlertTriggeredContext.md)
* [`RefundedPaymentContext`](RefundedPaymentContext.md)
* [`RemovedChatBoostContext`](RemovedChatBoostContext.md)
* [`ShippingQueryContext`](ShippingQueryContext.md)
* [`SuccessfulPaymentContext`](SuccessfulPaymentContext.md)
* [`SuggestedPostApprovalFailedContext`](SuggestedPostApprovalFailedContext.md)
* [`SuggestedPostApprovedContext`](SuggestedPostApprovedContext.md)
* [`SuggestedPostDeclinedContext`](SuggestedPostDeclinedContext.md)
* [`SuggestedPostPaidContext`](SuggestedPostPaidContext.md)
* [`SuggestedPostRefundedContext`](SuggestedPostRefundedContext.md)
* [`UniqueGiftContext`](UniqueGiftContext.md)
* [`UsersSharedContext`](UsersSharedContext.md)
* [`VideoChatEndedContext`](VideoChatEndedContext.md)
* [`VideoChatParticipantsInvitedContext`](VideoChatParticipantsInvitedContext.md)
* [`VideoChatScheduledContext`](VideoChatScheduledContext.md)
* [`VideoChatStartedContext`](VideoChatStartedContext.md)
* [`WebAppDataContext`](WebAppDataContext.md)
* [`WriteAccessAllowedContext`](WriteAccessAllowedContext.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new SendMixin**<`Bot`>(): `SendMixin`<`Bot`>

#### Returns

`SendMixin`<`Bot`>

#### Inherited from

[`Context`](Context.md).[`constructor`](Context.md#constructor)

## Properties

| Property | Modifier | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | contexts/index.d.ts:4863 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4859

##### Returns

`number`

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4861

##### Returns

`number`

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

## Methods

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

---

---
url: 'https://gramio.dev/api/contexts/classes/SentWebAppMessage.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SentWebAppMessage

# Class: SentWebAppMessage

Defined in: contexts/index.d.ts:4456

Contains information about an inline message sent by a Web App on behalf of a user.

## Constructors

### Constructor

> **new SentWebAppMessage**(`payload`): `SentWebAppMessage`

Defined in: contexts/index.d.ts:4458

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramSentWebAppMessage`](../../../../gramio/interfaces/TelegramSentWebAppMessage.md) |

#### Returns

`SentWebAppMessage`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramSentWebAppMessage`](../../../../gramio/interfaces/TelegramSentWebAppMessage.md) | contexts/index.d.ts:4457 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4460

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### inlineMessageId

#### Get Signature

> **get** **inlineMessageId**(): `string`

Defined in: contexts/index.d.ts:4466

Identifier of the sent inline message.

Available only if there is an inline keyboard attached to the message.

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/SharedUser.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SharedUser

# Class: SharedUser

Defined in: contexts/index.d.ts:2297

This object contains information about the user whose identifier was shared with the bot using a `KeyboardButtonRequestUser` button.

## Constructors

### Constructor

> **new SharedUser**(`payload`): `SharedUser`

Defined in: contexts/index.d.ts:2299

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramSharedUser`](../../../../gramio/interfaces/TelegramSharedUser.md) |

#### Returns

`SharedUser`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramSharedUser`](../../../../gramio/interfaces/TelegramSharedUser.md) | contexts/index.d.ts:2298 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2301

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### firstName

#### Get Signature

> **get** **firstName**(): `string`

Defined in: contexts/index.d.ts:2305

First name of the user, if the name was requested by the bot

##### Returns

`string`

***

### lastName

#### Get Signature

> **get** **lastName**(): `string`

Defined in: contexts/index.d.ts:2307

Last name of the user, if the name was requested by the bot

##### Returns

`string`

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:2311

Available sizes of the chat photo, if the photo was requested by the bot

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

***

### userId

#### Get Signature

> **get** **userId**(): `number`

Defined in: contexts/index.d.ts:2303

Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.

##### Returns

`number`

***

### username

#### Get Signature

> **get** **username**(): `string`

Defined in: contexts/index.d.ts:2309

Username of the user, if the username was requested by the bot

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/ShippingAddress.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ShippingAddress

# Class: ShippingAddress

Defined in: contexts/index.d.ts:2216

This object represents a shipping address.

## Constructors

### Constructor

> **new ShippingAddress**(`payload`): `ShippingAddress`

Defined in: contexts/index.d.ts:2218

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramShippingAddress`](../../../../gramio/interfaces/TelegramShippingAddress.md) |

#### Returns

`ShippingAddress`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramShippingAddress`](../../../../gramio/interfaces/TelegramShippingAddress.md) | contexts/index.d.ts:2217 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2220

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### city

#### Get Signature

> **get** **city**(): `string`

Defined in: contexts/index.d.ts:2226

City

##### Returns

`string`

***

### countryCode

#### Get Signature

> **get** **countryCode**(): `string`

Defined in: contexts/index.d.ts:2222

ISO 3166-1 alpha-2 country code

##### Returns

`string`

***

### firstStreetLine

#### Get Signature

> **get** **firstStreetLine**(): `string`

Defined in: contexts/index.d.ts:2228

First line for the address

##### Returns

`string`

***

### postCode

#### Get Signature

> **get** **postCode**(): `string`

Defined in: contexts/index.d.ts:2232

Address post code

##### Returns

`string`

***

### secondStreetLine

#### Get Signature

> **get** **secondStreetLine**(): `string`

Defined in: contexts/index.d.ts:2230

Second line for the address

##### Returns

`string`

***

### state

#### Get Signature

> **get** **state**(): `string`

Defined in: contexts/index.d.ts:2224

State, if applicable

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/ShippingQuery.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ShippingQuery

# Class: ShippingQuery

Defined in: contexts/index.d.ts:4470

This object contains information about an incoming shipping query.

## Extended by

* [`ShippingQueryContext`](ShippingQueryContext.md)

## Constructors

### Constructor

> **new ShippingQuery**(`payload`): `ShippingQuery`

Defined in: contexts/index.d.ts:4472

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramShippingQuery`](../../../../gramio/interfaces/TelegramShippingQuery.md) |

#### Returns

`ShippingQuery`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramShippingQuery`](../../../../gramio/interfaces/TelegramShippingQuery.md) | contexts/index.d.ts:4471 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4474

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4478

User who sent the query

##### Returns

[`User`](User.md)

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:4476

Unique query identifier

##### Returns

`string`

***

### invoicePayload

#### Get Signature

> **get** **invoicePayload**(): `string`

Defined in: contexts/index.d.ts:4482

Bot specified invoice payload

##### Returns

`string`

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4480

Sender ID

##### Returns

`number`

***

### shippingAddress

#### Get Signature

> **get** **shippingAddress**(): [`ShippingAddress`](ShippingAddress.md)

Defined in: contexts/index.d.ts:4484

User specified shipping address

##### Returns

[`ShippingAddress`](ShippingAddress.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/ShippingQueryContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ShippingQueryContext

# Class: ShippingQueryContext\<Bot>

Defined in: contexts/index.d.ts:6382

This object contains information about an incoming shipping query.

[Documentation](https://core.telegram.org/bots/api/#shippingquery)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ShippingQueryContext`<`Bot`>>.[`ShippingQuery`](ShippingQuery.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ShippingQueryContext`<`Bot`>, `ShippingQueryContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ShippingQueryContext**<`Bot`>(`options`): `ShippingQueryContext`<`Bot`>

Defined in: contexts/index.d.ts:6385

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ShippingQueryContextOptions`<`Bot`> |

#### Returns

`ShippingQueryContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ShippingQueryContext**(...`args`): `ShippingQueryContext`

Defined in: contexts/index.d.ts:6382

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ShippingQueryContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4863 |
|  `payload` | `public` | [`TelegramShippingQuery`](../../../../gramio/interfaces/TelegramShippingQuery.md) | The raw data that is used for this Context | [`ShippingQuery`](ShippingQuery.md).[`payload`](ShippingQuery.md#payload) | contexts/index.d.ts:6384 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4860

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4859

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4478

User who sent the query

##### Returns

[`User`](User.md)

#### Inherited from

[`ShippingQuery`](ShippingQuery.md).[`from`](ShippingQuery.md#from)

***

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: contexts/index.d.ts:4476

Unique query identifier

##### Returns

`string`

#### Inherited from

[`ShippingQuery`](ShippingQuery.md).[`id`](ShippingQuery.md#id)

***

### invoicePayload

#### Get Signature

> **get** **invoicePayload**(): `string`

Defined in: contexts/index.d.ts:4482

Bot specified invoice payload

##### Returns

`string`

#### Inherited from

[`ShippingQuery`](ShippingQuery.md).[`invoicePayload`](ShippingQuery.md#invoicepayload)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4480

Sender ID

##### Returns

`number`

#### Inherited from

[`ShippingQuery`](ShippingQuery.md).[`senderId`](ShippingQuery.md#senderid)

***

### shippingAddress

#### Get Signature

> **get** **shippingAddress**(): [`ShippingAddress`](ShippingAddress.md)

Defined in: contexts/index.d.ts:4484

User specified shipping address

##### Returns

[`ShippingAddress`](ShippingAddress.md)

#### Inherited from

[`ShippingQuery`](ShippingQuery.md).[`shippingAddress`](ShippingQuery.md#shippingaddress)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4862

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### answer()

> **answer**<`Ok`>(`ok?`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:6389

Replies to shipping queries. An alias for `answerShippingQuery`

#### Type Parameters

| Type Parameter |
| ------ |
| `Ok` *extends* `boolean` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ok?` | `Ok` |
| `params?` | `Pick`<[`AnswerShippingQueryParams`](../../../../gramio/interfaces/AnswerShippingQueryParams.md), `"error_message"` | `"shipping_options"`> & `object` & `Required`<`Pick`<[`AnswerShippingQueryParams`](../../../../gramio/interfaces/AnswerShippingQueryParams.md), `true` *extends* `Ok` ? `"shipping_options"` : `"error_message"`>> |

#### Returns

`Promise`<`true`>

***

### answerShippingQuery()

> **answerShippingQuery**<`Ok`>(`ok?`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:6387

Replies to shipping queries

#### Type Parameters

| Type Parameter |
| ------ |
| `Ok` *extends* `boolean` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ok?` | `Ok` |
| `params?` | `Pick`<[`AnswerShippingQueryParams`](../../../../gramio/interfaces/AnswerShippingQueryParams.md), `"error_message"` | `"shipping_options"`> & `object` & `Required`<`Pick`<[`AnswerShippingQueryParams`](../../../../gramio/interfaces/AnswerShippingQueryParams.md), `true` *extends* `Ok` ? `"shipping_options"` : `"error_message"`>> |

#### Returns

`Promise`<`true`>

***

### clone()

> **clone**(`options?`): `ShippingQueryContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ShippingQueryContextOptions` |

#### Returns

`ShippingQueryContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/StickerAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / StickerAttachment

# Class: StickerAttachment

Defined in: contexts/index.d.ts:715

This object represents a sticker.

## Extends

* [`FileAttachment`](FileAttachment.md)<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)>

## Constructors

### Constructor

> **new StickerAttachment**(`payload`): `StickerAttachment`

Defined in: contexts/index.d.ts:327

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md) |

#### Returns

`StickerAttachment`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`constructor`](FileAttachment.md#constructor)

## Properties

| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|  `attachmentType` | `public` | [`AttachmentType`](../type-aliases/AttachmentType.md) | Returns attachment's type (e.g. `'audio'`, `'photo'`) | [`FileAttachment`](FileAttachment.md).[`attachmentType`](FileAttachment.md#attachmenttype) | - | contexts/index.d.ts:716 |
|  `payload` | `protected` | [`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md) | - | - | [`FileAttachment`](FileAttachment.md).[`payload`](FileAttachment.md#payload) | contexts/index.d.ts:324 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:314

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`[toStringTag]`](FileAttachment.md#tostringtag)

***

### customEmojiId

#### Get Signature

> **get** **customEmojiId**(): `string`

Defined in: contexts/index.d.ts:744

For custom emoji stickers, unique identifier of the custom emoji

##### Returns

`string`

***

### emoji

#### Get Signature

> **get** **emoji**(): `string`

Defined in: contexts/index.d.ts:734

Emoji associated with the sticker

##### Returns

`string`

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

Defined in: contexts/index.d.ts:329

Identifier for this file, which can be used to download or reuse the file

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileId`](FileAttachment.md#fileid)

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

Defined in: contexts/index.d.ts:748

File size

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

Defined in: contexts/index.d.ts:334

Unique identifier for this file, which is supposed to be the same over
time and for different bots. Can't be used to download or reuse the file.

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileUniqueId`](FileAttachment.md#fileuniqueid)

***

### height

#### Get Signature

> **get** **height**(): `number`

Defined in: contexts/index.d.ts:726

Sticker height

##### Returns

`number`

***

### maskPosition

#### Get Signature

> **get** **maskPosition**(): [`MaskPosition`](MaskPosition.md)

Defined in: contexts/index.d.ts:742

For mask stickers, the position where the mask should be placed

##### Returns

[`MaskPosition`](MaskPosition.md)

***

### needs\_repainting

#### Get Signature

> **get** **needs\_repainting**(): `true`

Defined in: contexts/index.d.ts:746

`true`, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places

##### Returns

`true`

***

### premiumAnimation

#### Get Signature

> **get** **premiumAnimation**(): [`File`](File.md)

Defined in: contexts/index.d.ts:740

Premium animation for the sticker, if the sticker is premium

##### Returns

[`File`](File.md)

***

### setName

#### Get Signature

> **get** **setName**(): `string`

Defined in: contexts/index.d.ts:736

Name of the sticker set to which the sticker belongs

##### Returns

`string`

***

### thumbnail

#### Get Signature

> **get** **thumbnail**(): [`PhotoSize`](PhotoSize.md)

Defined in: contexts/index.d.ts:732

Sticker thumbnail in the .WEBP or .JPG format

##### Returns

[`PhotoSize`](PhotoSize.md)

***

### type

#### Get Signature

> **get** **type**(): [`TelegramStickerType`](../../../../gramio/type-aliases/TelegramStickerType.md)

Defined in: contexts/index.d.ts:722

Type of the sticker, currently one of `regular`, `mask`, `custom_emoji`.

The type of the sticker is independent from its format, which is determined by the fields `is_animated` and `is_video`.

##### Returns

[`TelegramStickerType`](../../../../gramio/type-aliases/TelegramStickerType.md)

***

### width

#### Get Signature

> **get** **width**(): `number`

Defined in: contexts/index.d.ts:724

Sticker width

##### Returns

`number`

## Methods

### isAnimated()

> **isAnimated**(): `boolean`

Defined in: contexts/index.d.ts:728

`true`, if the sticker is animated

#### Returns

`boolean`

***

### isPremium()

> **isPremium**(): `this is Require<StickerAttachment, "premiumAnimation">`

Defined in: contexts/index.d.ts:738

Is this sticker a premium one?

#### Returns

`this is Require<StickerAttachment, "premiumAnimation">`

***

### isVideo()

> **isVideo**(): `boolean`

Defined in: contexts/index.d.ts:730

`true`, if the sticker is a video sticker

#### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/contexts/classes/StickerSet.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / StickerSet

# Class: StickerSet

Defined in: contexts/index.d.ts:4488

This object represents a sticker set.

## Constructors

### Constructor

> **new StickerSet**(`payload`): `StickerSet`

Defined in: contexts/index.d.ts:4490

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramStickerSet`](../../../../gramio/interfaces/TelegramStickerSet.md) |

#### Returns

`StickerSet`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramStickerSet`](../../../../gramio/interfaces/TelegramStickerSet.md) | contexts/index.d.ts:4489 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4492

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: contexts/index.d.ts:4494

Sticker set name

##### Returns

`string`

***

### stickers

#### Get Signature

> **get** **stickers**(): [`StickerAttachment`](StickerAttachment.md)\[]

Defined in: contexts/index.d.ts:4500

List of all set stickers

##### Returns

[`StickerAttachment`](StickerAttachment.md)\[]

***

### stickerType

#### Get Signature

> **get** **stickerType**(): [`TelegramStickerSetStickerType`](../../../../gramio/type-aliases/TelegramStickerSetStickerType.md)

Defined in: contexts/index.d.ts:4498

Type of stickers in the set, currently one of `regular`, `mask`, `custom_emoji`

##### Returns

[`TelegramStickerSetStickerType`](../../../../gramio/type-aliases/TelegramStickerSetStickerType.md)

***

### thumbnail

#### Get Signature

> **get** **thumbnail**(): [`PhotoSize`](PhotoSize.md)

Defined in: contexts/index.d.ts:4502

Sticker set thumbnail in the .WEBP or .TGS format

##### Returns

[`PhotoSize`](PhotoSize.md)

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:4496

Sticker set title

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/Story.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Story

# Class: Story

Defined in: contexts/index.d.ts:800

This object represents a story.

[Documentation](https://core.telegram.org/bots/api/#story)

## Extended by

* [`StoryAttachment`](StoryAttachment.md)

## Constructors

### Constructor

> **new Story**(`payload`): `Story`

Defined in: contexts/index.d.ts:802

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramStory`](../../../../gramio/interfaces/TelegramStory.md) |

#### Returns

`Story`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramStory`](../../../../gramio/interfaces/TelegramStory.md) | contexts/index.d.ts:801 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:804

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:808

Chat that posted the story

##### Returns

[`Chat`](Chat.md)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:806

Unique identifier for the story in the chat

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/StoryAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / StoryAttachment

# Class: StoryAttachment

Defined in: contexts/index.d.ts:816

This object represents a story.

[Documentation](https://core.telegram.org/bots/api/#story)

## Extends

* [`Story`](Story.md).[`Attachment`](Attachment.md)

## Constructors

### Constructor

> **new StoryAttachment**(`payload`): `StoryAttachment`

Defined in: contexts/index.d.ts:802

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramStory`](../../../../gramio/interfaces/TelegramStory.md) |

#### Returns

`StoryAttachment`

#### Inherited from

[`Story`](Story.md).[`constructor`](Story.md#constructor)

## Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
|  `attachmentType` | [`AttachmentType`](../type-aliases/AttachmentType.md) | [`Attachment`](Attachment.md).[`attachmentType`](Attachment.md#attachmenttype) | contexts/index.d.ts:817 |
|  `payload` | [`TelegramStory`](../../../../gramio/interfaces/TelegramStory.md) | [`Story`](Story.md).[`payload`](Story.md#payload) | contexts/index.d.ts:801 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:804

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Story`](Story.md).[`[toStringTag]`](Story.md#tostringtag)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:808

Chat that posted the story

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Story`](Story.md).[`chat`](Story.md#chat)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:806

Unique identifier for the story in the chat

##### Returns

`number`

#### Inherited from

[`Story`](Story.md).[`id`](Story.md#id)

---

---
url: 'https://gramio.dev/api/contexts/classes/SuccessfulPayment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuccessfulPayment

# Class: SuccessfulPayment

Defined in: contexts/index.d.ts:2252

This object contains basic information about a successful payment.

## Constructors

### Constructor

> **new SuccessfulPayment**(`payload`): `SuccessfulPayment`

Defined in: contexts/index.d.ts:2254

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramSuccessfulPayment`](../../../../gramio/interfaces/TelegramSuccessfulPayment.md) |

#### Returns

`SuccessfulPayment`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramSuccessfulPayment`](../../../../gramio/interfaces/TelegramSuccessfulPayment.md) | contexts/index.d.ts:2253 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2256

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### currency

#### Get Signature

> **get** **currency**(): [`TelegramCurrencies`](../../../../gramio/type-aliases/TelegramCurrencies.md)

Defined in: contexts/index.d.ts:2258

Three-letter ISO 4217 currency code

##### Returns

[`TelegramCurrencies`](../../../../gramio/type-aliases/TelegramCurrencies.md)

***

### invoicePayload

#### Get Signature

> **get** **invoicePayload**(): `string`

Defined in: contexts/index.d.ts:2269

Bot specified invoice payload

##### Returns

`string`

***

### orderInfo

#### Get Signature

> **get** **orderInfo**(): [`OrderInfo`](OrderInfo.md)

Defined in: contexts/index.d.ts:2273

Order info provided by the user

##### Returns

[`OrderInfo`](OrderInfo.md)

***

### providerPaymentChargeId

#### Get Signature

> **get** **providerPaymentChargeId**(): `string`

Defined in: contexts/index.d.ts:2277

Provider payment identifier

##### Returns

`string`

***

### shippingOptionId

#### Get Signature

> **get** **shippingOptionId**(): `string`

Defined in: contexts/index.d.ts:2271

Identifier of the shipping option chosen by the user

##### Returns

`string`

***

### telegramPaymentChargeId

#### Get Signature

> **get** **telegramPaymentChargeId**(): `string`

Defined in: contexts/index.d.ts:2275

Telegram payment identifier

##### Returns

`string`

***

### totalAmount

#### Get Signature

> **get** **totalAmount**(): `number`

Defined in: contexts/index.d.ts:2267

Total price in the smallest units of the currency
(integer, not float/double). For example, for a price of
`US$ 1.45` pass `amount = 145`. See the `exp` parameter in
[currencies.json](https://core.telegram.org/bots/payments/currencies.json),
it shows the number of digits past the decimal point for each currency
(2 for the majority of currencies).

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/SuccessfulPaymentContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuccessfulPaymentContext

# Class: SuccessfulPaymentContext\<Bot>

Defined in: contexts/index.d.ts:6501

This object contains basic information about a successful payment.

[Documentation](https://core.telegram.org/bots/api/#successfulpayment)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`SuccessfulPaymentContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `SuccessfulPaymentContext`<`Bot`>, `SuccessfulPaymentContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new SuccessfulPaymentContext**<`Bot`>(`options`): `SuccessfulPaymentContext`<`Bot`>

Defined in: contexts/index.d.ts:6504

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `SuccessfulPaymentContextOptions`<`Bot`> |

#### Returns

`SuccessfulPaymentContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new SuccessfulPaymentContext**(...`args`): `SuccessfulPaymentContext`

Defined in: contexts/index.d.ts:6501

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`SuccessfulPaymentContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6503 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventPayment

#### Get Signature

> **get** **eventPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:6506

Received payment

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `SuccessfulPaymentContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `SuccessfulPaymentContextOptions` |

#### Returns

`SuccessfulPaymentContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<SuccessfulPaymentContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<SuccessfulPaymentContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<SuccessfulPaymentContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<SuccessfulPaymentContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<SuccessfulPaymentContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<SuccessfulPaymentContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<SuccessfulPaymentContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<SuccessfulPaymentContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<SuccessfulPaymentContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<SuccessfulPaymentContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<SuccessfulPaymentContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<SuccessfulPaymentContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/SuggestedPostApprovalFailed.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuggestedPostApprovalFailed

# Class: SuggestedPostApprovalFailed

Defined in: contexts/index.d.ts:2679

Describes a service message about the failed approval of a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostapprovalfailed)

## Constructors

### Constructor

> **new SuggestedPostApprovalFailed**(`payload`): `SuggestedPostApprovalFailed`

Defined in: contexts/index.d.ts:2681

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramSuggestedPostApprovalFailed`](../../../../gramio/interfaces/TelegramSuggestedPostApprovalFailed.md) |

#### Returns

`SuggestedPostApprovalFailed`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramSuggestedPostApprovalFailed`](../../../../gramio/interfaces/TelegramSuggestedPostApprovalFailed.md) | contexts/index.d.ts:2680 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2683

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### price

#### Get Signature

> **get** **price**(): [`SuggestedPostPrice`](SuggestedPostPrice.md)

Defined in: contexts/index.d.ts:2687

Expected price of the post

##### Returns

[`SuggestedPostPrice`](SuggestedPostPrice.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/SuggestedPostApprovalFailedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuggestedPostApprovalFailedContext

# Class: SuggestedPostApprovalFailedContext\<Bot>

Defined in: contexts/index.d.ts:6401

This object represents a service message about the failed approval of a suggested post.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`SuggestedPostApprovalFailedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `SuggestedPostApprovalFailedContext`<`Bot`>, `SuggestedPostApprovalFailedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new SuggestedPostApprovalFailedContext**<`Bot`>(`options`): `SuggestedPostApprovalFailedContext`<`Bot`>

Defined in: contexts/index.d.ts:6405

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `SuggestedPostApprovalFailedContextOptions`<`Bot`> |

#### Returns

`SuggestedPostApprovalFailedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new SuggestedPostApprovalFailedContext**(...`args`): `SuggestedPostApprovalFailedContext`

Defined in: contexts/index.d.ts:6401

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`SuggestedPostApprovalFailedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6403 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### price

#### Get Signature

> **get** **price**(): [`SuggestedPostPrice`](SuggestedPostPrice.md)

Defined in: contexts/index.d.ts:6407

Expected price of the post

##### Returns

[`SuggestedPostPrice`](SuggestedPostPrice.md)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `SuggestedPostApprovalFailedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `SuggestedPostApprovalFailedContextOptions` |

#### Returns

`SuggestedPostApprovalFailedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<SuggestedPostApprovalFailedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<SuggestedPostApprovalFailedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<SuggestedPostApprovalFailedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<SuggestedPostApprovalFailedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<SuggestedPostApprovalFailedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<SuggestedPostApprovalFailedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<SuggestedPostApprovalFailedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<SuggestedPostApprovalFailedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<SuggestedPostApprovalFailedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<SuggestedPostApprovalFailedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<SuggestedPostApprovalFailedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<SuggestedPostApprovalFailedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/SuggestedPostApproved.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuggestedPostApproved

# Class: SuggestedPostApproved

Defined in: contexts/index.d.ts:2695

Describes a service message about the approval of a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostapproved)

## Constructors

### Constructor

> **new SuggestedPostApproved**(`payload`): `SuggestedPostApproved`

Defined in: contexts/index.d.ts:2697

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramSuggestedPostApproved`](../../../../gramio/interfaces/TelegramSuggestedPostApproved.md) |

#### Returns

`SuggestedPostApproved`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramSuggestedPostApproved`](../../../../gramio/interfaces/TelegramSuggestedPostApproved.md) | contexts/index.d.ts:2696 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2699

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### price

#### Get Signature

> **get** **price**(): [`SuggestedPostPrice`](SuggestedPostPrice.md)

Defined in: contexts/index.d.ts:2703

*Optional*. Amount paid for the post

##### Returns

[`SuggestedPostPrice`](SuggestedPostPrice.md)

***

### sendDate

#### Get Signature

> **get** **sendDate**(): `number`

Defined in: contexts/index.d.ts:2707

Date when the post will be published

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/SuggestedPostApprovedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuggestedPostApprovedContext

# Class: SuggestedPostApprovedContext\<Bot>

Defined in: contexts/index.d.ts:6419

This object represents a service message about the approval of a suggested post.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`SuggestedPostApprovedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `SuggestedPostApprovedContext`<`Bot`>, `SuggestedPostApprovedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new SuggestedPostApprovedContext**<`Bot`>(`options`): `SuggestedPostApprovedContext`<`Bot`>

Defined in: contexts/index.d.ts:6423

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `SuggestedPostApprovedContextOptions`<`Bot`> |

#### Returns

`SuggestedPostApprovedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new SuggestedPostApprovedContext**(...`args`): `SuggestedPostApprovedContext`

Defined in: contexts/index.d.ts:6419

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`SuggestedPostApprovedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6421 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### price

#### Get Signature

> **get** **price**(): [`SuggestedPostPrice`](SuggestedPostPrice.md)

Defined in: contexts/index.d.ts:6425

*Optional*. Amount paid for the post

##### Returns

[`SuggestedPostPrice`](SuggestedPostPrice.md)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### sendDate

#### Get Signature

> **get** **sendDate**(): `number`

Defined in: contexts/index.d.ts:6427

Date when the post will be published

##### Returns

`number`

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `SuggestedPostApprovedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `SuggestedPostApprovedContextOptions` |

#### Returns

`SuggestedPostApprovedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<SuggestedPostApprovedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<SuggestedPostApprovedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<SuggestedPostApprovedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<SuggestedPostApprovedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<SuggestedPostApprovedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<SuggestedPostApprovedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<SuggestedPostApprovedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<SuggestedPostApprovedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<SuggestedPostApprovedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<SuggestedPostApprovedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<SuggestedPostApprovedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<SuggestedPostApprovedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/SuggestedPostDeclined.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuggestedPostDeclined

# Class: SuggestedPostDeclined

Defined in: contexts/index.d.ts:2715

Describes a service message about the rejection of a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostdeclined)

## Constructors

### Constructor

> **new SuggestedPostDeclined**(`payload`): `SuggestedPostDeclined`

Defined in: contexts/index.d.ts:2717

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramSuggestedPostDeclined`](../../../../gramio/interfaces/TelegramSuggestedPostDeclined.md) |

#### Returns

`SuggestedPostDeclined`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramSuggestedPostDeclined`](../../../../gramio/interfaces/TelegramSuggestedPostDeclined.md) | contexts/index.d.ts:2716 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2719

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### comment

#### Get Signature

> **get** **comment**(): `string`

Defined in: contexts/index.d.ts:2723

*Optional*. Comment with which the post was declined

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/SuggestedPostDeclinedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuggestedPostDeclinedContext

# Class: SuggestedPostDeclinedContext\<Bot>

Defined in: contexts/index.d.ts:6439

This object represents a service message about the rejection of a suggested post.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`SuggestedPostDeclinedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `SuggestedPostDeclinedContext`<`Bot`>, `SuggestedPostDeclinedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new SuggestedPostDeclinedContext**<`Bot`>(`options`): `SuggestedPostDeclinedContext`<`Bot`>

Defined in: contexts/index.d.ts:6443

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `SuggestedPostDeclinedContextOptions`<`Bot`> |

#### Returns

`SuggestedPostDeclinedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new SuggestedPostDeclinedContext**(...`args`): `SuggestedPostDeclinedContext`

Defined in: contexts/index.d.ts:6439

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`SuggestedPostDeclinedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6441 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### comment

#### Get Signature

> **get** **comment**(): `string`

Defined in: contexts/index.d.ts:6445

*Optional*. Comment with which the post was declined

##### Returns

`string`

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `SuggestedPostDeclinedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `SuggestedPostDeclinedContextOptions` |

#### Returns

`SuggestedPostDeclinedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<SuggestedPostDeclinedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<SuggestedPostDeclinedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<SuggestedPostDeclinedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<SuggestedPostDeclinedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<SuggestedPostDeclinedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<SuggestedPostDeclinedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<SuggestedPostDeclinedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<SuggestedPostDeclinedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<SuggestedPostDeclinedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<SuggestedPostDeclinedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<SuggestedPostDeclinedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<SuggestedPostDeclinedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/SuggestedPostInfo.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuggestedPostInfo

# Class: SuggestedPostInfo

Defined in: contexts/index.d.ts:2731

Contains information about a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostinfo)

## Constructors

### Constructor

> **new SuggestedPostInfo**(`payload`): `SuggestedPostInfo`

Defined in: contexts/index.d.ts:2733

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramSuggestedPostInfo`](../../../../gramio/interfaces/TelegramSuggestedPostInfo.md) |

#### Returns

`SuggestedPostInfo`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramSuggestedPostInfo`](../../../../gramio/interfaces/TelegramSuggestedPostInfo.md) | contexts/index.d.ts:2732 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2735

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### price

#### Get Signature

> **get** **price**(): [`SuggestedPostPrice`](SuggestedPostPrice.md)

Defined in: contexts/index.d.ts:2743

*Optional*. Proposed price of the post. If the field is omitted, then the post is unpaid.

##### Returns

[`SuggestedPostPrice`](SuggestedPostPrice.md)

***

### sendDate

#### Get Signature

> **get** **sendDate**(): `number`

Defined in: contexts/index.d.ts:2747

*Optional*. Proposed send date of the post.

##### Returns

`number`

***

### state

#### Get Signature

> **get** **state**(): [`TelegramSuggestedPostInfoState`](../../../../gramio/type-aliases/TelegramSuggestedPostInfoState.md)

Defined in: contexts/index.d.ts:2739

State of the suggested post. Currently, it can be one of "pending", "approved", "declined".

##### Returns

[`TelegramSuggestedPostInfoState`](../../../../gramio/type-aliases/TelegramSuggestedPostInfoState.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/SuggestedPostPaid.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuggestedPostPaid

# Class: SuggestedPostPaid

Defined in: contexts/index.d.ts:2755

Describes a service message about a successful payment for a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostpaid)

## Constructors

### Constructor

> **new SuggestedPostPaid**(`payload`): `SuggestedPostPaid`

Defined in: contexts/index.d.ts:2757

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramSuggestedPostPaid`](../../../../gramio/interfaces/TelegramSuggestedPostPaid.md) |

#### Returns

`SuggestedPostPaid`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramSuggestedPostPaid`](../../../../gramio/interfaces/TelegramSuggestedPostPaid.md) | contexts/index.d.ts:2756 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2759

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### amount

#### Get Signature

> **get** **amount**(): `number`

Defined in: contexts/index.d.ts:2767

*Optional*. The amount of the currency that was received by the channel in nanotoncoins; for payments in toncoins only

##### Returns

`number`

***

### currency

#### Get Signature

> **get** **currency**(): [`TelegramSuggestedPostPaidCurrency`](../../../../gramio/type-aliases/TelegramSuggestedPostPaidCurrency.md)

Defined in: contexts/index.d.ts:2763

Currency in which the payment was made. Currently, one of "XTR" for Telegram Stars or "TON" for toncoins

##### Returns

[`TelegramSuggestedPostPaidCurrency`](../../../../gramio/type-aliases/TelegramSuggestedPostPaidCurrency.md)

***

### starAmount

#### Get Signature

> **get** **starAmount**(): [`TelegramStarAmount`](../../../../gramio/interfaces/TelegramStarAmount.md)

Defined in: contexts/index.d.ts:2771

*Optional*. The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only

##### Returns

[`TelegramStarAmount`](../../../../gramio/interfaces/TelegramStarAmount.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/SuggestedPostPaidContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuggestedPostPaidContext

# Class: SuggestedPostPaidContext\<Bot>

Defined in: contexts/index.d.ts:6457

This object represents a service message about a successful payment for a suggested post.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`SuggestedPostPaidContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `SuggestedPostPaidContext`<`Bot`>, `SuggestedPostPaidContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new SuggestedPostPaidContext**<`Bot`>(`options`): `SuggestedPostPaidContext`<`Bot`>

Defined in: contexts/index.d.ts:6461

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `SuggestedPostPaidContextOptions`<`Bot`> |

#### Returns

`SuggestedPostPaidContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new SuggestedPostPaidContext**(...`args`): `SuggestedPostPaidContext`

Defined in: contexts/index.d.ts:6457

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`SuggestedPostPaidContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6459 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### amount

#### Get Signature

> **get** **amount**(): `number`

Defined in: contexts/index.d.ts:6465

*Optional*. The amount of the currency that was received by the channel in nanotoncoins; for payments in toncoins only

##### Returns

`number`

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### currency

#### Get Signature

> **get** **currency**(): [`TelegramSuggestedPostPaidCurrency`](../../../../gramio/type-aliases/TelegramSuggestedPostPaidCurrency.md)

Defined in: contexts/index.d.ts:6463

Currency in which the payment was made

##### Returns

[`TelegramSuggestedPostPaidCurrency`](../../../../gramio/type-aliases/TelegramSuggestedPostPaidCurrency.md)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### starAmount

#### Get Signature

> **get** **starAmount**(): [`TelegramStarAmount`](../../../../gramio/interfaces/TelegramStarAmount.md)

Defined in: contexts/index.d.ts:6467

*Optional*. The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only

##### Returns

[`TelegramStarAmount`](../../../../gramio/interfaces/TelegramStarAmount.md)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `SuggestedPostPaidContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `SuggestedPostPaidContextOptions` |

#### Returns

`SuggestedPostPaidContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<SuggestedPostPaidContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<SuggestedPostPaidContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<SuggestedPostPaidContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<SuggestedPostPaidContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<SuggestedPostPaidContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<SuggestedPostPaidContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<SuggestedPostPaidContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<SuggestedPostPaidContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<SuggestedPostPaidContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<SuggestedPostPaidContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<SuggestedPostPaidContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<SuggestedPostPaidContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/SuggestedPostPrice.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuggestedPostPrice

# Class: SuggestedPostPrice

Defined in: contexts/index.d.ts:2659

Describes price of a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostprice)

## Constructors

### Constructor

> **new SuggestedPostPrice**(`payload`): `SuggestedPostPrice`

Defined in: contexts/index.d.ts:2661

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramSuggestedPostPrice`](../../../../gramio/interfaces/TelegramSuggestedPostPrice.md) |

#### Returns

`SuggestedPostPrice`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramSuggestedPostPrice`](../../../../gramio/interfaces/TelegramSuggestedPostPrice.md) | contexts/index.d.ts:2660 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2663

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### amount

#### Get Signature

> **get** **amount**(): `number`

Defined in: contexts/index.d.ts:2671

The amount of the currency that will be paid for the post in the smallest units of the currency

##### Returns

`number`

***

### currency

#### Get Signature

> **get** **currency**(): [`TelegramSuggestedPostPriceCurrency`](../../../../gramio/type-aliases/TelegramSuggestedPostPriceCurrency.md)

Defined in: contexts/index.d.ts:2667

Currency in which the post will be paid. Currently, must be one of "XTR" for Telegram Stars or "TON" for toncoins

##### Returns

[`TelegramSuggestedPostPriceCurrency`](../../../../gramio/type-aliases/TelegramSuggestedPostPriceCurrency.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/SuggestedPostRefunded.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuggestedPostRefunded

# Class: SuggestedPostRefunded

Defined in: contexts/index.d.ts:2779

Describes a service message about a payment refund for a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostrefunded)

## Constructors

### Constructor

> **new SuggestedPostRefunded**(`payload`): `SuggestedPostRefunded`

Defined in: contexts/index.d.ts:2781

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramSuggestedPostRefunded`](../../../../gramio/interfaces/TelegramSuggestedPostRefunded.md) |

#### Returns

`SuggestedPostRefunded`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramSuggestedPostRefunded`](../../../../gramio/interfaces/TelegramSuggestedPostRefunded.md) | contexts/index.d.ts:2780 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2783

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### reason

#### Get Signature

> **get** **reason**(): [`TelegramSuggestedPostRefundedReason`](../../../../gramio/type-aliases/TelegramSuggestedPostRefundedReason.md)

Defined in: contexts/index.d.ts:2787

Reason for the refund. Currently, one of "post\_deleted", or "payment\_refunded"

##### Returns

[`TelegramSuggestedPostRefundedReason`](../../../../gramio/type-aliases/TelegramSuggestedPostRefundedReason.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/SuggestedPostRefundedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SuggestedPostRefundedContext

# Class: SuggestedPostRefundedContext\<Bot>

Defined in: contexts/index.d.ts:6479

This object represents a service message about a payment refund for a suggested post.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`SuggestedPostRefundedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `SuggestedPostRefundedContext`<`Bot`>, `SuggestedPostRefundedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new SuggestedPostRefundedContext**<`Bot`>(`options`): `SuggestedPostRefundedContext`<`Bot`>

Defined in: contexts/index.d.ts:6483

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `SuggestedPostRefundedContextOptions`<`Bot`> |

#### Returns

`SuggestedPostRefundedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new SuggestedPostRefundedContext**(...`args`): `SuggestedPostRefundedContext`

Defined in: contexts/index.d.ts:6479

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`SuggestedPostRefundedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6481 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### reason

#### Get Signature

> **get** **reason**(): [`TelegramSuggestedPostRefundedReason`](../../../../gramio/type-aliases/TelegramSuggestedPostRefundedReason.md)

Defined in: contexts/index.d.ts:6485

Reason for the refund

##### Returns

[`TelegramSuggestedPostRefundedReason`](../../../../gramio/type-aliases/TelegramSuggestedPostRefundedReason.md)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `SuggestedPostRefundedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `SuggestedPostRefundedContextOptions` |

#### Returns

`SuggestedPostRefundedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<SuggestedPostRefundedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<SuggestedPostRefundedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<SuggestedPostRefundedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<SuggestedPostRefundedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<SuggestedPostRefundedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<SuggestedPostRefundedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<SuggestedPostRefundedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<SuggestedPostRefundedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<SuggestedPostRefundedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<SuggestedPostRefundedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<SuggestedPostRefundedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<SuggestedPostRefundedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/TargetMixin.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / TargetMixin

# Class: TargetMixin

Defined in: contexts/index.d.ts:4739

This object represents a mixin which has sender data (e.g. `senderId`, `from` etc.)

## Extended by

* [`BoostAddedContext`](BoostAddedContext.md)
* [`ChatBackgroundSetContext`](ChatBackgroundSetContext.md)
* [`ChatControlMixin`](ChatControlMixin.md)
* [`ChatInviteControlMixin`](ChatInviteControlMixin.md)
* [`ChatJoinRequestContext`](ChatJoinRequestContext.md)
* [`ChatMemberContext`](ChatMemberContext.md)
* [`ChatMemberControlMixin`](ChatMemberControlMixin.md)
* [`ChatOwnerChangedContext`](ChatOwnerChangedContext.md)
* [`ChatOwnerLeftContext`](ChatOwnerLeftContext.md)
* [`ChatSenderControlMixin`](ChatSenderControlMixin.md)
* [`ChatSharedContext`](ChatSharedContext.md)
* [`ChecklistTasksAddedContext`](ChecklistTasksAddedContext.md)
* [`ChecklistTasksDoneContext`](ChecklistTasksDoneContext.md)
* [`DeleteChatPhotoContext`](DeleteChatPhotoContext.md)
* [`DirectMessagePriceChangedContext`](DirectMessagePriceChangedContext.md)
* [`ForumTopicClosedContext`](ForumTopicClosedContext.md)
* [`ForumTopicCreatedContext`](ForumTopicCreatedContext.md)
* [`ForumTopicEditedContext`](ForumTopicEditedContext.md)
* [`ForumTopicReopenedContext`](ForumTopicReopenedContext.md)
* [`GeneralForumTopicHiddenContext`](GeneralForumTopicHiddenContext.md)
* [`GeneralForumTopicUnhiddenContext`](GeneralForumTopicUnhiddenContext.md)
* [`GiftContext`](GiftContext.md)
* [`GiftUpgradeSentContext`](GiftUpgradeSentContext.md)
* [`GiveawayCompletedContext`](GiveawayCompletedContext.md)
* [`GiveawayCreatedContext`](GiveawayCreatedContext.md)
* [`GiveawayWinnersContext`](GiveawayWinnersContext.md)
* [`GroupChatCreatedContext`](GroupChatCreatedContext.md)
* [`InvoiceContext`](InvoiceContext.md)
* [`LeftChatMemberContext`](LeftChatMemberContext.md)
* [`LocationContext`](LocationContext.md)
* [`MessageAutoDeleteTimerChangedContext`](MessageAutoDeleteTimerChangedContext.md)
* [`MessageContext`](MessageContext.md)
* [`MigrateFromChatIdContext`](MigrateFromChatIdContext.md)
* [`MigrateToChatIdContext`](MigrateToChatIdContext.md)
* [`NewChatMembersContext`](NewChatMembersContext.md)
* [`NewChatPhotoContext`](NewChatPhotoContext.md)
* [`NewChatTitleContext`](NewChatTitleContext.md)
* [`PaidMediaPurchasedContext`](PaidMediaPurchasedContext.md)
* [`PaidMessagePriceChangedContext`](PaidMessagePriceChangedContext.md)
* [`PassportDataContext`](PassportDataContext.md)
* [`PinnedMessageContext`](PinnedMessageContext.md)
* [`PinsMixin`](PinsMixin.md)
* [`ProximityAlertTriggeredContext`](ProximityAlertTriggeredContext.md)
* [`RefundedPaymentContext`](RefundedPaymentContext.md)
* [`SuccessfulPaymentContext`](SuccessfulPaymentContext.md)
* [`SuggestedPostApprovalFailedContext`](SuggestedPostApprovalFailedContext.md)
* [`SuggestedPostApprovedContext`](SuggestedPostApprovedContext.md)
* [`SuggestedPostDeclinedContext`](SuggestedPostDeclinedContext.md)
* [`SuggestedPostPaidContext`](SuggestedPostPaidContext.md)
* [`SuggestedPostRefundedContext`](SuggestedPostRefundedContext.md)
* [`UniqueGiftContext`](UniqueGiftContext.md)
* [`UsersSharedContext`](UsersSharedContext.md)
* [`VideoChatEndedContext`](VideoChatEndedContext.md)
* [`VideoChatParticipantsInvitedContext`](VideoChatParticipantsInvitedContext.md)
* [`VideoChatScheduledContext`](VideoChatScheduledContext.md)
* [`VideoChatStartedContext`](VideoChatStartedContext.md)
* [`WebAppDataContext`](WebAppDataContext.md)
* [`WriteAccessAllowedContext`](WriteAccessAllowedContext.md)

## Constructors

### Constructor

> **new TargetMixin**(): `TargetMixin`

#### Returns

`TargetMixin`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | `Record`<`string`, `any`> | contexts/index.d.ts:4740 |

## Accessors

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:4765

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4759

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:4744

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:4757

*Optional*. If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:4753

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

## Methods

### hasFrom()

> **hasFrom**(): this is Require\<TargetMixin, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<TargetMixin, "from" | "senderId">

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<TargetMixin, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<TargetMixin, "senderChat">`

***

### isChannel()

> **isChannel**(): `this is RequireValue<TargetMixin, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<TargetMixin, "chatType", Channel>`

***

### isGroup()

> **isGroup**(): `this is RequireValue<TargetMixin, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<TargetMixin, "chatType", Group>`

***

### isPM()

> **isPM**(): `this is RequireValue<TargetMixin, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<TargetMixin, "chatType", Private>`

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<TargetMixin, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<TargetMixin, "chatType", Supergroup>`

---

---
url: 'https://gramio.dev/api/gramio/classes/TelegramError.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramError

# Class: TelegramError\<T>

Defined in: gramio/index.d.ts:20

Represent [TelegramAPIResponseError](../interfaces/TelegramAPIResponseError.md) and thrown in API calls

## Extends

* `Error`

## Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |

## Constructors

### Constructor

> **new TelegramError**<`T`>(`error`, `method`, `params`, `callSite?`): `TelegramError`<`T`>

Defined in: gramio/index.d.ts:30

Construct new TelegramError

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `error` | [`TelegramAPIResponseError`](../interfaces/TelegramAPIResponseError.md) |
| `method` | `T` |
| `params` | [`MaybeSuppressedParams`](../type-aliases/MaybeSuppressedParams.md)<`T`> |
| `callSite?` | `Error` |

#### Returns

`TelegramError`<`T`>

#### Overrides

`Error.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `cause?` | `public` | `unknown` | - | `Error.cause` | typescript/lib/lib.es2022.error.d.ts:26 |
|  `code` | `public` | `number` | See [TelegramAPIResponseError.error\_code](../interfaces/TelegramAPIResponseError.md#error_code) | - | gramio/index.d.ts:26 |
|  `message` | `public` | `string` | - | `Error.message` | typescript/lib/lib.es5.d.ts:1077 |
|  `method` | `public` | `T` | Name of the API Method | - | gramio/index.d.ts:22 |
|  `name` | `public` | `string` | - | `Error.name` | typescript/lib/lib.es5.d.ts:1076 |
|  `params` | `public` | [`MaybeSuppressedParams`](../type-aliases/MaybeSuppressedParams.md)<`T`> | Params that were sent | - | gramio/index.d.ts:24 |
|  `payload?` | `public` | [`TelegramResponseParameters`](../interfaces/TelegramResponseParameters.md) | Describes why a request was unsuccessful. | - | gramio/index.d.ts:28 |
|  `stack?` | `public` | `string` | - | `Error.stack` | typescript/lib/lib.es5.d.ts:1078 |
|  `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured *after* the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | @types/node/globals.d.ts:67 |

## Methods

### captureStackTrace()

> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`

Defined in: @types/node/globals.d.ts:51

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:

```js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `targetObject` | `object` |
| `constructorOpt?` | `Function` |

#### Returns

`void`

#### Inherited from

`Error.captureStackTrace`

***

### prepareStackTrace()

> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`

Defined in: @types/node/globals.d.ts:55

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `err` | `Error` |
| `stackTraces` | `CallSite`\[] |

#### Returns

`any`

#### See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

#### Inherited from

`Error.prepareStackTrace`

---

---
url: 'https://gramio.dev/api/contexts/classes/TextQuote.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / TextQuote

# Class: TextQuote

Defined in: contexts/index.d.ts:2281

This object contains information about the quoted part of a message that is replied to by the given message.

## Constructors

### Constructor

> **new TextQuote**(`payload`): `TextQuote`

Defined in: contexts/index.d.ts:2283

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramTextQuote`](../../../../gramio/interfaces/TelegramTextQuote.md) |

#### Returns

`TextQuote`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramTextQuote`](../../../../gramio/interfaces/TelegramTextQuote.md) | contexts/index.d.ts:2282 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2285

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2289

Special entities that appear in the quote. Currently, only `bold`, `italic`, `underline`, `strikethrough`, `spoiler`, and `custom_emoji` entities are kept in quotes.

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

***

### position

#### Get Signature

> **get** **position**(): `number`

Defined in: contexts/index.d.ts:2291

Approximate quote position in the original message in UTF-16 code units as specified by the sender

##### Returns

`number`

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2287

Text of the quoted part of a message that is replied to by the given message

##### Returns

`string`

## Methods

### isManual()

> **isManual**(): `true`

Defined in: contexts/index.d.ts:2293

`true`, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.

#### Returns

`true`

---

---
url: 'https://gramio.dev/api/contexts/classes/UniqueGift.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UniqueGift

# Class: UniqueGift

Defined in: contexts/index.d.ts:2830

This object describes a unique gift that was upgraded from a regular gift.

[Documentation](https://core.telegram.org/bots/api/#uniquegift)

## Constructors

### Constructor

> **new UniqueGift**(`payload`): `UniqueGift`

Defined in: contexts/index.d.ts:2832

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUniqueGift`](../../../../gramio/interfaces/TelegramUniqueGift.md) |

#### Returns

`UniqueGift`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUniqueGift`](../../../../gramio/interfaces/TelegramUniqueGift.md) | contexts/index.d.ts:2831 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2834

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### baseName

#### Get Signature

> **get** **baseName**(): `string`

Defined in: contexts/index.d.ts:2842

Human-readable name of the regular gift from which this unique gift was upgraded

##### Returns

`string`

***

### colors

#### Get Signature

> **get** **colors**(): [`UniqueGiftColors`](UniqueGiftColors.md)

Defined in: contexts/index.d.ts:2858

*Optional*. The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews

##### Returns

[`UniqueGiftColors`](UniqueGiftColors.md)

***

### giftId

#### Get Signature

> **get** **giftId**(): `string`

Defined in: contexts/index.d.ts:2838

Identifier of the regular gift from which the gift was upgraded

##### Returns

`string`

***

### isBurned

#### Get Signature

> **get** **isBurned**(): `true`

Defined in: contexts/index.d.ts:2854

*Optional*. True, if the gift was used to craft another gift and isn't available anymore

##### Returns

`true`

***

### isFromBlockchain

#### Get Signature

> **get** **isFromBlockchain**(): `true`

Defined in: contexts/index.d.ts:2856

*Optional*. True, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram

##### Returns

`true`

***

### isPremium

#### Get Signature

> **get** **isPremium**(): `true`

Defined in: contexts/index.d.ts:2852

*Optional*. True, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers

##### Returns

`true`

***

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: contexts/index.d.ts:2846

Unique name of the gift. This name can be used in `https://t.me/nft/...` links and story areas

##### Returns

`string`

***

### number

#### Get Signature

> **get** **number**(): `number`

Defined in: contexts/index.d.ts:2850

Unique number of the upgraded gift among gifts upgraded from the same regular gift

##### Returns

`number`

***

### publisherChat

#### Get Signature

> **get** **publisherChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2860

*Optional*. Information about the chat that published the gift

##### Returns

[`Chat`](Chat.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/UniqueGiftBackdrop.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UniqueGiftBackdrop

# Class: UniqueGiftBackdrop

Defined in: contexts/index.d.ts:4538

This object describes the colors of the backdrop of a unique gift.

[Documentation](https://core.telegram.org/bots/api/#uniquegiftbackdropcolors)

## Constructors

### Constructor

> **new UniqueGiftBackdrop**(`payload`): `UniqueGiftBackdrop`

Defined in: contexts/index.d.ts:4540

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUniqueGiftBackdrop`](../../../../gramio/interfaces/TelegramUniqueGiftBackdrop.md) |

#### Returns

`UniqueGiftBackdrop`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUniqueGiftBackdrop`](../../../../gramio/interfaces/TelegramUniqueGiftBackdrop.md) | contexts/index.d.ts:4539 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4542

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### colors

#### Get Signature

> **get** **colors**(): [`UniqueGiftBackdropColors`](UniqueGiftBackdropColors.md)

Defined in: contexts/index.d.ts:4550

Colors of the backdrop

##### Returns

[`UniqueGiftBackdropColors`](UniqueGiftBackdropColors.md)

***

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: contexts/index.d.ts:4546

Name of the backdrop

##### Returns

`string`

***

### rarityPerMille

#### Get Signature

> **get** **rarityPerMille**(): `number`

Defined in: contexts/index.d.ts:4554

The number of unique gifts that receive this model for every 1000 gifts upgraded

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/UniqueGiftBackdropColors.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UniqueGiftBackdropColors

# Class: UniqueGiftBackdropColors

Defined in: contexts/index.d.ts:4510

Describes a service message about a regular gift that was sent or received.

[Documentation](https://core.telegram.org/bots/api/#giftinfo)

## Constructors

### Constructor

> **new UniqueGiftBackdropColors**(`payload`): `UniqueGiftBackdropColors`

Defined in: contexts/index.d.ts:4512

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUniqueGiftBackdropColors`](../../../../gramio/interfaces/TelegramUniqueGiftBackdropColors.md) |

#### Returns

`UniqueGiftBackdropColors`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUniqueGiftBackdropColors`](../../../../gramio/interfaces/TelegramUniqueGiftBackdropColors.md) | contexts/index.d.ts:4511 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4514

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### centerColor

#### Get Signature

> **get** **centerColor**(): `number`

Defined in: contexts/index.d.ts:4518

The color in the center of the backdrop in RGB format

##### Returns

`number`

***

### edgeColor

#### Get Signature

> **get** **edgeColor**(): `number`

Defined in: contexts/index.d.ts:4522

The color on the edges of the backdrop in RGB format

##### Returns

`number`

***

### symbolColor

#### Get Signature

> **get** **symbolColor**(): `number`

Defined in: contexts/index.d.ts:4526

The color to be applied to the symbol in RGB format

##### Returns

`number`

***

### textColor

#### Get Signature

> **get** **textColor**(): `number`

Defined in: contexts/index.d.ts:4530

The color for the text on the backdrop in RGB format

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/UniqueGiftColors.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UniqueGiftColors

# Class: UniqueGiftColors

Defined in: contexts/index.d.ts:2795

This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.

[Documentation](https://core.telegram.org/bots/api/#uniquegiftcolors)

## Constructors

### Constructor

> **new UniqueGiftColors**(`payload`): `UniqueGiftColors`

Defined in: contexts/index.d.ts:2797

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUniqueGiftColors`](../../../../gramio/interfaces/TelegramUniqueGiftColors.md) |

#### Returns

`UniqueGiftColors`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUniqueGiftColors`](../../../../gramio/interfaces/TelegramUniqueGiftColors.md) | contexts/index.d.ts:2796 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2798

##### Returns

`string`

***

### darkThemeMainColor

#### Get Signature

> **get** **darkThemeMainColor**(): `number`

Defined in: contexts/index.d.ts:2818

Main color used in dark themes; RGB format

##### Returns

`number`

***

### darkThemeOtherColors

#### Get Signature

> **get** **darkThemeOtherColors**(): `number`\[]

Defined in: contexts/index.d.ts:2822

List of 1-3 additional colors used in dark themes; RGB format

##### Returns

`number`\[]

***

### lightThemeMainColor

#### Get Signature

> **get** **lightThemeMainColor**(): `number`

Defined in: contexts/index.d.ts:2810

Main color used in light themes; RGB format

##### Returns

`number`

***

### lightThemeOtherColors

#### Get Signature

> **get** **lightThemeOtherColors**(): `number`\[]

Defined in: contexts/index.d.ts:2814

List of 1-3 additional colors used in light themes; RGB format

##### Returns

`number`\[]

***

### modelCustomEmojiId

#### Get Signature

> **get** **modelCustomEmojiId**(): `string`

Defined in: contexts/index.d.ts:2802

Custom emoji identifier of the unique gift's model

##### Returns

`string`

***

### symbolCustomEmojiId

#### Get Signature

> **get** **symbolCustomEmojiId**(): `string`

Defined in: contexts/index.d.ts:2806

Custom emoji identifier of the unique gift's symbol

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/UniqueGiftContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UniqueGiftContext

# Class: UniqueGiftContext\<Bot>

Defined in: contexts/index.d.ts:6518

This object contains information about the chat whose identifier was shared with the bot using a `KeyboardButtonRequestChat` button.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`UniqueGiftContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `UniqueGiftContext`<`Bot`>, `UniqueGiftContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new UniqueGiftContext**<`Bot`>(`options`): `UniqueGiftContext`<`Bot`>

Defined in: contexts/index.d.ts:6522

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `UniqueGiftContextOptions`<`Bot`> |

#### Returns

`UniqueGiftContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new UniqueGiftContext**(...`args`): `UniqueGiftContext`

Defined in: contexts/index.d.ts:6518

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`UniqueGiftContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6520 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### nextTransferDate

#### Get Signature

> **get** **nextTransferDate**(): `Date`

Defined in: contexts/index.d.ts:6542

*Optional*. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now

##### Returns

`Date`

***

### origin

#### Get Signature

> **get** **origin**(): [`TelegramUniqueGiftInfoOrigin`](../../../../gramio/type-aliases/TelegramUniqueGiftInfoOrigin.md)

Defined in: contexts/index.d.ts:6530

Origin of the gift. Currently, either “upgrade” or “transfer”

##### Returns

[`TelegramUniqueGiftInfoOrigin`](../../../../gramio/type-aliases/TelegramUniqueGiftInfoOrigin.md)

***

### ownedGiftId

#### Get Signature

> **get** **ownedGiftId**(): `string`

Defined in: contexts/index.d.ts:6534

*Optional*. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts

##### Returns

`string`

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### transferStarCount

#### Get Signature

> **get** **transferStarCount**(): `number`

Defined in: contexts/index.d.ts:6538

*Optional*. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift

##### Returns

`number`

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### uniqueGiftInfo

#### Get Signature

> **get** **uniqueGiftInfo**(): [`UniqueGift`](UniqueGift.md)

Defined in: contexts/index.d.ts:6526

Information about the gift

##### Returns

[`UniqueGift`](UniqueGift.md)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `UniqueGiftContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `UniqueGiftContextOptions` |

#### Returns

`UniqueGiftContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<UniqueGiftContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<UniqueGiftContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<UniqueGiftContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<UniqueGiftContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<UniqueGiftContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<UniqueGiftContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<UniqueGiftContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<UniqueGiftContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<UniqueGiftContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<UniqueGiftContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<UniqueGiftContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<UniqueGiftContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/UniqueGiftInfo.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UniqueGiftInfo

# Class: UniqueGiftInfo

Defined in: contexts/index.d.ts:2868

Describes a service message about a unique gift that was sent or received.

[Documentation](https://core.telegram.org/bots/api/#uniquegiftinfo)

## Constructors

### Constructor

> **new UniqueGiftInfo**(`payload`): `UniqueGiftInfo`

Defined in: contexts/index.d.ts:2870

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUniqueGiftInfo`](../../../../gramio/interfaces/TelegramUniqueGiftInfo.md) |

#### Returns

`UniqueGiftInfo`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUniqueGiftInfo`](../../../../gramio/interfaces/TelegramUniqueGiftInfo.md) | contexts/index.d.ts:2869 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2872

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### gift

#### Get Signature

> **get** **gift**(): [`UniqueGift`](UniqueGift.md)

Defined in: contexts/index.d.ts:2876

Information about the gift

##### Returns

[`UniqueGift`](UniqueGift.md)

***

### lastResaleAmount

#### Get Signature

> **get** **lastResaleAmount**(): `number`

Defined in: contexts/index.d.ts:2888

*Optional*. For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins

##### Returns

`number`

***

### lastResaleCurrency

#### Get Signature

> **get** **lastResaleCurrency**(): [`TelegramUniqueGiftInfoLastResaleCurrency`](../../../../gramio/type-aliases/TelegramUniqueGiftInfoLastResaleCurrency.md)

Defined in: contexts/index.d.ts:2884

*Optional*. For gifts bought from other users, the currency in which the payment for the gift was done. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins

##### Returns

[`TelegramUniqueGiftInfoLastResaleCurrency`](../../../../gramio/type-aliases/TelegramUniqueGiftInfoLastResaleCurrency.md)

***

### lastResaleStarCount

#### Get Signature

> **get** **lastResaleStarCount**(): `number`

Defined in: contexts/index.d.ts:2892

*Optional*. For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins

##### Returns

`number`

***

### nextTransferDate

#### Get Signature

> **get** **nextTransferDate**(): `number`

Defined in: contexts/index.d.ts:2904

*Optional*. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now

##### Returns

`number`

***

### origin

#### Get Signature

> **get** **origin**(): [`TelegramUniqueGiftInfoOrigin`](../../../../gramio/type-aliases/TelegramUniqueGiftInfoOrigin.md)

Defined in: contexts/index.d.ts:2880

Origin of the gift. Currently, either “upgrade” or “transfer”

##### Returns

[`TelegramUniqueGiftInfoOrigin`](../../../../gramio/type-aliases/TelegramUniqueGiftInfoOrigin.md)

***

### ownedGiftId

#### Get Signature

> **get** **ownedGiftId**(): `string`

Defined in: contexts/index.d.ts:2896

*Optional*. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts

##### Returns

`string`

***

### transferStarCount

#### Get Signature

> **get** **transferStarCount**(): `number`

Defined in: contexts/index.d.ts:2900

*Optional*. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/UniqueGiftModel.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UniqueGiftModel

# Class: UniqueGiftModel

Defined in: contexts/index.d.ts:4562

Describes a service message about a regular gift that was sent or received.

[Documentation](https://core.telegram.org/bots/api/#giftinfo)

## Constructors

### Constructor

> **new UniqueGiftModel**(`payload`): `UniqueGiftModel`

Defined in: contexts/index.d.ts:4564

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUniqueGiftModel`](../../../../gramio/interfaces/TelegramUniqueGiftModel.md) |

#### Returns

`UniqueGiftModel`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUniqueGiftModel`](../../../../gramio/interfaces/TelegramUniqueGiftModel.md) | contexts/index.d.ts:4563 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4566

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: contexts/index.d.ts:4570

Name of the model

##### Returns

`string`

***

### rarity

#### Get Signature

> **get** **rarity**(): [`TelegramUniqueGiftModelRarity`](../../../../gramio/type-aliases/TelegramUniqueGiftModelRarity.md)

Defined in: contexts/index.d.ts:4582

*Optional*. Rarity of the model if it is a crafted model. Currently, can be "uncommon", "rare", "epic", or "legendary".

##### Returns

[`TelegramUniqueGiftModelRarity`](../../../../gramio/type-aliases/TelegramUniqueGiftModelRarity.md)

***

### rarityPerMille

#### Get Signature

> **get** **rarityPerMille**(): `number`

Defined in: contexts/index.d.ts:4578

The number of unique gifts that receive this model for every 1000 gifts upgraded

##### Returns

`number`

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:4574

The sticker that represents the unique gift

##### Returns

[`StickerAttachment`](StickerAttachment.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/UniqueGiftSymbol.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UniqueGiftSymbol

# Class: UniqueGiftSymbol

Defined in: contexts/index.d.ts:4590

Describes a service message about a regular gift that was sent or received.

[Documentation](https://core.telegram.org/bots/api/#giftinfo)

## Constructors

### Constructor

> **new UniqueGiftSymbol**(`payload`): `UniqueGiftSymbol`

Defined in: contexts/index.d.ts:4592

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUniqueGiftSymbol`](../../../../gramio/interfaces/TelegramUniqueGiftSymbol.md) |

#### Returns

`UniqueGiftSymbol`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUniqueGiftSymbol`](../../../../gramio/interfaces/TelegramUniqueGiftSymbol.md) | contexts/index.d.ts:4591 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4594

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: contexts/index.d.ts:4598

Name of the model

##### Returns

`string`

***

### rarityPerMille

#### Get Signature

> **get** **rarityPerMille**(): `number`

Defined in: contexts/index.d.ts:4606

The number of unique gifts that receive this model for every 1000 gifts upgraded

##### Returns

`number`

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:4602

The sticker that represents the unique gift

##### Returns

[`StickerAttachment`](StickerAttachment.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/Update.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Update

# Class: Update

Defined in: contexts/index.d.ts:4615

This object represents an incoming update.

At most **one** of the optional parameters can be present in any given
update.

## Constructors

### Constructor

> **new Update**(`payload`): `Update`

Defined in: contexts/index.d.ts:4617

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) |

#### Returns

`Update`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | contexts/index.d.ts:4616 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4619

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### callbackQuery

#### Get Signature

> **get** **callbackQuery**(): [`CallbackQuery`](CallbackQuery.md)

Defined in: contexts/index.d.ts:4653

New incoming callback query

##### Returns

[`CallbackQuery`](CallbackQuery.md)

***

### channelPost

#### Get Signature

> **get** **channelPost**(): [`Message`](Message.md)

Defined in: contexts/index.d.ts:4637

New incoming channel post of any kind — text, photo, sticker, etc.

##### Returns

[`Message`](Message.md)

***

### chatBoost

#### Get Signature

> **get** **chatBoost**(): [`ChatBoostUpdated`](ChatBoostUpdated.md)

Defined in: contexts/index.d.ts:4681

A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.

##### Returns

[`ChatBoostUpdated`](ChatBoostUpdated.md)

***

### chatJoinRequest

#### Get Signature

> **get** **chatJoinRequest**(): [`ChatJoinRequest`](ChatJoinRequest.md)

Defined in: contexts/index.d.ts:4679

A request to join the chat has been sent. The bot must have the `can_invite_users` administrator right in the chat to receive these updates.

##### Returns

[`ChatJoinRequest`](ChatJoinRequest.md)

***

### chatMember

#### Get Signature

> **get** **chatMember**(): [`ChatMemberUpdated`](ChatMemberUpdated.md)

Defined in: contexts/index.d.ts:4677

A chat member's status was updated in a chat.

The bot must be an administrator in the chat and must explicitly specify `chat_member` in the list of `allowed_updates` to receive these updates.

##### Returns

[`ChatMemberUpdated`](ChatMemberUpdated.md)

***

### chosenInlineResult

#### Get Signature

> **get** **chosenInlineResult**(): [`ChosenInlineResult`](ChosenInlineResult.md)

Defined in: contexts/index.d.ts:4651

The result of an inline query that was chosen by a user and sent to their
chat partner. Please see our documentation on the feedback collecting for
details on how to enable these updates for your bot.

##### Returns

[`ChosenInlineResult`](ChosenInlineResult.md)

***

### editedChannelPost

#### Get Signature

> **get** **editedChannelPost**(): [`Message`](Message.md)

Defined in: contexts/index.d.ts:4639

New version of a channel post that is known to the bot and was edited

##### Returns

[`Message`](Message.md)

***

### editedMessage

#### Get Signature

> **get** **editedMessage**(): [`Message`](Message.md)

Defined in: contexts/index.d.ts:4635

New version of a message that is known to the bot and was edited

##### Returns

[`Message`](Message.md)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4629

The update's unique identifier.
Update identifiers start from a certain positive number and increase
sequentially. This ID becomes especially handy if you're using
**Webhooks**, since it allows you to ignore repeated updates or to restore
the correct update sequence, should they get out of order. If there are no
new updates for at least a week, then identifier of the next update will
be chosen randomly instead of sequentially.

##### Returns

`number`

***

### inlineQuery

#### Get Signature

> **get** **inlineQuery**(): [`InlineQuery`](InlineQuery.md)

Defined in: contexts/index.d.ts:4645

New incoming inline query

##### Returns

[`InlineQuery`](InlineQuery.md)

***

### message

#### Get Signature

> **get** **message**(): [`Message`](Message.md)

Defined in: contexts/index.d.ts:4633

New incoming message of any kind — text, photo, sticker, etc.

##### Returns

[`Message`](Message.md)

***

### messageReaction

#### Get Signature

> **get** **messageReaction**(): [`MessageReactionUpdated`](MessageReactionUpdated.md)

Defined in: contexts/index.d.ts:4641

A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify `message_reaction` in the list of allowed\_updates to receive these updates. The update isn't received for reactions set by bots.

##### Returns

[`MessageReactionUpdated`](MessageReactionUpdated.md)

***

### messageReactionCount

#### Get Signature

> **get** **messageReactionCount**(): [`MessageReactionCountUpdated`](MessageReactionCountUpdated.md)

Defined in: contexts/index.d.ts:4643

Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify `message_reaction_count` in the list of allowed\_updates to receive these updates.

##### Returns

[`MessageReactionCountUpdated`](MessageReactionCountUpdated.md)

***

### myChatMember

#### Get Signature

> **get** **myChatMember**(): [`ChatMemberUpdated`](ChatMemberUpdated.md)

Defined in: contexts/index.d.ts:4671

The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.

##### Returns

[`ChatMemberUpdated`](ChatMemberUpdated.md)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:4664

New poll state. Bots receive only updates about stopped polls and polls,
which are sent by the bot

##### Returns

[`Poll`](Poll.md)

***

### pollAnswer

#### Get Signature

> **get** **pollAnswer**(): [`PollAnswer`](PollAnswer.md)

Defined in: contexts/index.d.ts:4669

A user changed their answer in a non-anonymous poll. Bots receive new
votes only in polls that were sent by the bot itself.

##### Returns

[`PollAnswer`](PollAnswer.md)

***

### preCheckoutQuery

#### Get Signature

> **get** **preCheckoutQuery**(): [`PreCheckoutQuery`](PreCheckoutQuery.md)

Defined in: contexts/index.d.ts:4659

New incoming pre-checkout query. Contains full information about checkout

##### Returns

[`PreCheckoutQuery`](PreCheckoutQuery.md)

***

### removedChatBoost

#### Get Signature

> **get** **removedChatBoost**(): [`ChatBoostRemoved`](ChatBoostRemoved.md)

Defined in: contexts/index.d.ts:4683

A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.

##### Returns

[`ChatBoostRemoved`](ChatBoostRemoved.md)

***

### shippingQuery

#### Get Signature

> **get** **shippingQuery**(): [`ShippingQuery`](ShippingQuery.md)

Defined in: contexts/index.d.ts:4655

New incoming shipping query. Only for invoices with flexible price

##### Returns

[`ShippingQuery`](ShippingQuery.md)

---

---
url: 'https://gramio.dev/api/gramio/classes/Updates.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / Updates

# Class: Updates

Defined in: gramio/index.d.ts:834

## Constructors

### Constructor

> **new Updates**(`bot`, `onError`): `Updates`

Defined in: gramio/index.d.ts:842

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `bot` | [`AnyBot`](../type-aliases/AnyBot.md) |
| `onError` | (`context`, `error`) => `unknown` |

#### Returns

`Updates`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `composer` | [`EventComposer`](../../../composer/interfaces/EventComposer.md)<[`Context`](../../../contexts/classes/Context.md)<[`AnyBot`](../type-aliases/AnyBot.md)>, `TelegramEventMap`, [`Context`](../../../contexts/classes/Context.md)<[`AnyBot`](../type-aliases/AnyBot.md)>, [`Context`](../../../contexts/classes/Context.md)<[`AnyBot`](../type-aliases/AnyBot.md)>, `object`, `Record`<`string`, `object`>, { `callbackQuery`: `TThis`; `chosenInlineResult`: `TThis`; `command`: `TThis`; `hears`: `TThis`; `inlineQuery`: `TThis`; `reaction`: `TThis`; `startParameter`: `TThis`; }, [`MacroDefinitions`](../../../composer/type-aliases/MacroDefinitions.md)> & `object` | gramio/index.d.ts:839 |
|  `isRequestActive` | `boolean` | gramio/index.d.ts:837 |
|  `isStarted` | `boolean` | gramio/index.d.ts:836 |
|  `queue` | [`EventQueue`](../../../composer/classes/EventQueue.md)<[`TelegramUpdate`](../interfaces/TelegramUpdate.md)> | gramio/index.d.ts:840 |
|  `stopPollingPromiseResolve` | (`value?`) => `void` | gramio/index.d.ts:841 |

## Methods

### dropPendingUpdates()

> **dropPendingUpdates**(`deleteWebhookOnConflict?`): `Promise`<`void`>

Defined in: gramio/index.d.ts:847

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `deleteWebhookOnConflict?` | `boolean` |

#### Returns

`Promise`<`void`>

***

### handleUpdate()

> **handleUpdate**(`data`): `Promise`<`void`>

Defined in: gramio/index.d.ts:843

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `data` | [`TelegramUpdate`](../interfaces/TelegramUpdate.md) |

#### Returns

`Promise`<`void`>

***

### startFetchLoop()

> **startFetchLoop**(`params?`, `options?`): `Promise`<`void`>

Defined in: gramio/index.d.ts:846

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`GetUpdatesParams`](../interfaces/GetUpdatesParams.md) |
| `options?` | [`PollingStartOptions`](../interfaces/PollingStartOptions.md) |

#### Returns

`Promise`<`void`>

***

### ~~startPolling()~~

> **startPolling**(`params?`, `options?`): `void`

Defined in: gramio/index.d.ts:845

**`Internal`**

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`GetUpdatesParams`](../interfaces/GetUpdatesParams.md) |
| `options?` | [`PollingStartOptions`](../interfaces/PollingStartOptions.md) |

#### Returns

`void`

#### Deprecated

use bot.start instead

***

### stopPolling()

> **stopPolling**(`waitPendingRequests?`): `Promise`<`void`>

Defined in: gramio/index.d.ts:851

! Soon waitPendingRequests param default will changed to true

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `waitPendingRequests?` | `boolean` |

#### Returns

`Promise`<`void`>

---

---
url: 'https://gramio.dev/api/contexts/classes/User.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / User

# Class: User

Defined in: contexts/index.d.ts:476

This object represents a Telegram user or bot.

## Constructors

### Constructor

> **new User**(`payload`): `User`

Defined in: contexts/index.d.ts:478

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUser`](../../../../gramio/interfaces/TelegramUser.md) |

#### Returns

`User`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUser`](../../../../gramio/interfaces/TelegramUser.md) | contexts/index.d.ts:477 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:480

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### addedToAttachmentMenu

#### Get Signature

> **get** **addedToAttachmentMenu**(): `true`

Defined in: contexts/index.d.ts:499

`true`, if this user added the bot to the attachment menu

##### Returns

`true`

***

### firstName

#### Get Signature

> **get** **firstName**(): `string`

Defined in: contexts/index.d.ts:486

User's or bot's first name

##### Returns

`string`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:482

Unique identifier for this user or bot

##### Returns

`number`

***

### languageCode

#### Get Signature

> **get** **languageCode**(): `string`

Defined in: contexts/index.d.ts:495

[IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag)
of the user's language

##### Returns

`string`

***

### lastName

#### Get Signature

> **get** **lastName**(): `string`

Defined in: contexts/index.d.ts:488

User's or bot's last name

##### Returns

`string`

***

### username

#### Get Signature

> **get** **username**(): `string`

Defined in: contexts/index.d.ts:490

User's or bot's username

##### Returns

`string`

## Methods

### allowsUsersToCreateTopics()

> **allowsUsersToCreateTopics**(): `boolean`

Defined in: contexts/index.d.ts:529

`true`, if the bot allows users to create and delete topics in private chats.

Returned only in `getMe`.

#### Returns

`boolean`

***

### canConnectToBusiness()

> **canConnectToBusiness**(): `boolean`

Defined in: contexts/index.d.ts:523

`true`, if the bot can be connected to a Telegram Business account to receive its messages.

Returned only in `getMe`.

#### Returns

`boolean`

***

### canJoinGroups()

> **canJoinGroups**(): `boolean`

Defined in: contexts/index.d.ts:505

`true`, if the bot can be invited to groups.

Returned only in `getMe`.

#### Returns

`boolean`

***

### canReadAllGroupMessages()

> **canReadAllGroupMessages**(): `boolean`

Defined in: contexts/index.d.ts:511

`true`, if privacy mode is disabled for the bot.

Returned only in `getMe`.

#### Returns

`boolean`

***

### isBot()

> **isBot**(): `boolean`

Defined in: contexts/index.d.ts:484

`true`, if this user is a bot

#### Returns

`boolean`

***

### isPremium()

> **isPremium**(): `true`

Defined in: contexts/index.d.ts:497

`true`, if this user is a Telegram Premium user

#### Returns

`true`

***

### supportsInlineQueries()

> **supportsInlineQueries**(): `boolean`

Defined in: contexts/index.d.ts:517

`true`, if the bot supports inline queries.

Returned only in `getMe`.

#### Returns

`boolean`

---

---
url: 'https://gramio.dev/api/contexts/classes/UserProfileAudios.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UserProfileAudios

# Class: UserProfileAudios

Defined in: contexts/index.d.ts:4691

This object represents the audios displayed on a user's profile.

[Documentation](https://core.telegram.org/bots/api/#userprofileaudios)

## Constructors

### Constructor

> **new UserProfileAudios**(`payload`): `UserProfileAudios`

Defined in: contexts/index.d.ts:4693

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUserProfileAudios`](../../../../gramio/interfaces/TelegramUserProfileAudios.md) |

#### Returns

`UserProfileAudios`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUserProfileAudios`](../../../../gramio/interfaces/TelegramUserProfileAudios.md) | contexts/index.d.ts:4692 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4695

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### audios

#### Get Signature

> **get** **audios**(): [`AudioAttachment`](AudioAttachment.md)\[]

Defined in: contexts/index.d.ts:4703

Requested profile audios

##### Returns

[`AudioAttachment`](AudioAttachment.md)\[]

***

### totalCount

#### Get Signature

> **get** **totalCount**(): `number`

Defined in: contexts/index.d.ts:4699

Total number of profile audios for the target user

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/UserProfilePhotos.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UserProfilePhotos

# Class: UserProfilePhotos

Defined in: contexts/index.d.ts:4707

This object represent a user's profile pictures.

## Constructors

### Constructor

> **new UserProfilePhotos**(`payload`): `UserProfilePhotos`

Defined in: contexts/index.d.ts:4709

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUserProfilePhotos`](../../../../gramio/interfaces/TelegramUserProfilePhotos.md) |

#### Returns

`UserProfilePhotos`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUserProfilePhotos`](../../../../gramio/interfaces/TelegramUserProfilePhotos.md) | contexts/index.d.ts:4708 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4711

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### photos

#### Get Signature

> **get** **photos**(): [`PhotoSize`](PhotoSize.md)\[]\[]

Defined in: contexts/index.d.ts:4715

Requested profile pictures (in up to 4 sizes each)

##### Returns

[`PhotoSize`](PhotoSize.md)\[]\[]

***

### totalCount

#### Get Signature

> **get** **totalCount**(): `number`

Defined in: contexts/index.d.ts:4713

Total number of profile pictures the target user has

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/UserRating.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UserRating

# Class: UserRating

Defined in: contexts/index.d.ts:3494

This object describes the rating of a user based on their Telegram Star spendings.

[Documentation](https://core.telegram.org/bots/api/#userrating)

## Constructors

### Constructor

> **new UserRating**(`payload`): `UserRating`

Defined in: contexts/index.d.ts:3496

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUserRating`](../../../../gramio/interfaces/TelegramUserRating.md) |

#### Returns

`UserRating`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUserRating`](../../../../gramio/interfaces/TelegramUserRating.md) | contexts/index.d.ts:3495 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:3497

##### Returns

`string`

***

### currentLevelRating

#### Get Signature

> **get** **currentLevelRating**(): `number`

Defined in: contexts/index.d.ts:3509

The rating value required to get the current level

##### Returns

`number`

***

### level

#### Get Signature

> **get** **level**(): `number`

Defined in: contexts/index.d.ts:3501

Current level of the user, indicating their reliability when purchasing digital goods and services

##### Returns

`number`

***

### nextLevelRating

#### Get Signature

> **get** **nextLevelRating**(): `number`

Defined in: contexts/index.d.ts:3513

*Optional*. The rating value required to get to the next level; omitted if the maximum level was reached

##### Returns

`number`

***

### rating

#### Get Signature

> **get** **rating**(): `number`

Defined in: contexts/index.d.ts:3505

Numerical value of the user's rating; the higher the rating, the better

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/UsersShared.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UsersShared

# Class: UsersShared

Defined in: contexts/index.d.ts:2315

This object contains information about the user whose identifier was shared with the bot using a `KeyboardButtonRequestUser` button.

## Constructors

### Constructor

> **new UsersShared**(`payload`): `UsersShared`

Defined in: contexts/index.d.ts:2317

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramUsersShared`](../../../../gramio/interfaces/TelegramUsersShared.md) |

#### Returns

`UsersShared`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramUsersShared`](../../../../gramio/interfaces/TelegramUsersShared.md) | contexts/index.d.ts:2316 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2319

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### requestId

#### Get Signature

> **get** **requestId**(): `number`

Defined in: contexts/index.d.ts:2321

Identifier of the request

##### Returns

`number`

***

### users

#### Get Signature

> **get** **users**(): [`SharedUser`](SharedUser.md)\[]

Defined in: contexts/index.d.ts:2323

Information about users shared with the bot.

##### Returns

[`SharedUser`](SharedUser.md)\[]

---

---
url: 'https://gramio.dev/api/contexts/classes/UsersSharedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UsersSharedContext

# Class: UsersSharedContext\<Bot>

Defined in: contexts/index.d.ts:6554

This object contains information about the users whose identifiers were shared with the bot using a `KeyboardButtonRequestUsers` button.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`UsersSharedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `UsersSharedContext`<`Bot`>, `UsersSharedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new UsersSharedContext**<`Bot`>(`options`): `UsersSharedContext`<`Bot`>

Defined in: contexts/index.d.ts:6558

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `UsersSharedContextOptions`<`Bot`> |

#### Returns

`UsersSharedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new UsersSharedContext**(...`args`): `UsersSharedContext`

Defined in: contexts/index.d.ts:6554

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`UsersSharedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6556 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### requestId

#### Get Signature

> **get** **requestId**(): `number`

Defined in: contexts/index.d.ts:6560

Identifier of the request

##### Returns

`number`

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### users

#### Get Signature

> **get** **users**(): [`SharedUser`](SharedUser.md)\[]

Defined in: contexts/index.d.ts:6562

Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.

##### Returns

[`SharedUser`](SharedUser.md)\[]

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `UsersSharedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `UsersSharedContextOptions` |

#### Returns

`UsersSharedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<UsersSharedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<UsersSharedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<UsersSharedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<UsersSharedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<UsersSharedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<UsersSharedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<UsersSharedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<UsersSharedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<UsersSharedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<UsersSharedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<UsersSharedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<UsersSharedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/Venue.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Venue

# Class: Venue

Defined in: contexts/index.d.ts:823

This object represents a venue.

## Extended by

* [`VenueAttachment`](VenueAttachment.md)

## Constructors

### Constructor

> **new Venue**(`payload`): `Venue`

Defined in: contexts/index.d.ts:825

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramVenue`](../../../../gramio/interfaces/TelegramVenue.md) |

#### Returns

`Venue`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramVenue`](../../../../gramio/interfaces/TelegramVenue.md) | contexts/index.d.ts:824 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:827

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### address

#### Get Signature

> **get** **address**(): `string`

Defined in: contexts/index.d.ts:833

Address of the venue

##### Returns

`string`

***

### foursquareId

#### Get Signature

> **get** **foursquareId**(): `string`

Defined in: contexts/index.d.ts:835

Foursquare identifier of the venue

##### Returns

`string`

***

### foursquareType

#### Get Signature

> **get** **foursquareType**(): `string`

Defined in: contexts/index.d.ts:837

Foursquare type of the venue

##### Returns

`string`

***

### googlePlaceId

#### Get Signature

> **get** **googlePlaceId**(): `string`

Defined in: contexts/index.d.ts:839

Google Places identifier of the venue

##### Returns

`string`

***

### googlePlaceType

#### Get Signature

> **get** **googlePlaceType**(): `string`

Defined in: contexts/index.d.ts:844

Google Places type of the venue.
(See [supported types](https://developers.google.com/places/web-service/supported_types).)

##### Returns

`string`

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:829

Venue location

##### Returns

[`Location`](Location.md)

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:831

Name of the venue

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/VenueAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VenueAttachment

# Class: VenueAttachment

Defined in: contexts/index.d.ts:852

This object represents a venue.

[Documentation](https://core.telegram.org/bots/api/#venue)

## Extends

* [`Venue`](Venue.md).[`Attachment`](Attachment.md)

## Constructors

### Constructor

> **new VenueAttachment**(`payload`): `VenueAttachment`

Defined in: contexts/index.d.ts:825

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramVenue`](../../../../gramio/interfaces/TelegramVenue.md) |

#### Returns

`VenueAttachment`

#### Inherited from

[`Venue`](Venue.md).[`constructor`](Venue.md#constructor)

## Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
|  `attachmentType` | [`AttachmentType`](../type-aliases/AttachmentType.md) | [`Attachment`](Attachment.md).[`attachmentType`](Attachment.md#attachmenttype) | contexts/index.d.ts:853 |
|  `payload` | [`TelegramVenue`](../../../../gramio/interfaces/TelegramVenue.md) | [`Venue`](Venue.md).[`payload`](Venue.md#payload) | contexts/index.d.ts:824 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:827

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Venue`](Venue.md).[`[toStringTag]`](Venue.md#tostringtag)

***

### address

#### Get Signature

> **get** **address**(): `string`

Defined in: contexts/index.d.ts:833

Address of the venue

##### Returns

`string`

#### Inherited from

[`Venue`](Venue.md).[`address`](Venue.md#address)

***

### foursquareId

#### Get Signature

> **get** **foursquareId**(): `string`

Defined in: contexts/index.d.ts:835

Foursquare identifier of the venue

##### Returns

`string`

#### Inherited from

[`Venue`](Venue.md).[`foursquareId`](Venue.md#foursquareid)

***

### foursquareType

#### Get Signature

> **get** **foursquareType**(): `string`

Defined in: contexts/index.d.ts:837

Foursquare type of the venue

##### Returns

`string`

#### Inherited from

[`Venue`](Venue.md).[`foursquareType`](Venue.md#foursquaretype)

***

### googlePlaceId

#### Get Signature

> **get** **googlePlaceId**(): `string`

Defined in: contexts/index.d.ts:839

Google Places identifier of the venue

##### Returns

`string`

#### Inherited from

[`Venue`](Venue.md).[`googlePlaceId`](Venue.md#googleplaceid)

***

### googlePlaceType

#### Get Signature

> **get** **googlePlaceType**(): `string`

Defined in: contexts/index.d.ts:844

Google Places type of the venue.
(See [supported types](https://developers.google.com/places/web-service/supported_types).)

##### Returns

`string`

#### Inherited from

[`Venue`](Venue.md).[`googlePlaceType`](Venue.md#googleplacetype)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:829

Venue location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Venue`](Venue.md).[`location`](Venue.md#location)

***

### title

#### Get Signature

> **get** **title**(): `string`

Defined in: contexts/index.d.ts:831

Name of the venue

##### Returns

`string`

#### Inherited from

[`Venue`](Venue.md).[`title`](Venue.md#title)

---

---
url: 'https://gramio.dev/api/contexts/classes/VideoAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VideoAttachment

# Class: VideoAttachment

Defined in: contexts/index.d.ts:911

This object represents a video file.

## Extends

* [`FileAttachment`](FileAttachment.md)<[`TelegramVideo`](../../../../gramio/interfaces/TelegramVideo.md)>

## Constructors

### Constructor

> **new VideoAttachment**(`payload`): `VideoAttachment`

Defined in: contexts/index.d.ts:327

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramVideo`](../../../../gramio/interfaces/TelegramVideo.md) |

#### Returns

`VideoAttachment`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`constructor`](FileAttachment.md#constructor)

## Properties

| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|  `attachmentType` | `public` | [`AttachmentType`](../type-aliases/AttachmentType.md) | Returns attachment's type (e.g. `'audio'`, `'photo'`) | [`FileAttachment`](FileAttachment.md).[`attachmentType`](FileAttachment.md#attachmenttype) | - | contexts/index.d.ts:912 |
|  `payload` | `protected` | [`TelegramVideo`](../../../../gramio/interfaces/TelegramVideo.md) | - | - | [`FileAttachment`](FileAttachment.md).[`payload`](FileAttachment.md#payload) | contexts/index.d.ts:324 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:314

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`[toStringTag]`](FileAttachment.md#tostringtag)

***

### cover

#### Get Signature

> **get** **cover**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:928

Video cover

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

***

### duration

#### Get Signature

> **get** **duration**(): `number`

Defined in: contexts/index.d.ts:918

Duration of the video in seconds as defined by sender

##### Returns

`number`

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

Defined in: contexts/index.d.ts:329

Identifier for this file, which can be used to download or reuse the file

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileId`](FileAttachment.md#fileid)

***

### fileName

#### Get Signature

> **get** **fileName**(): `string`

Defined in: contexts/index.d.ts:922

Original filename as defined by sender

##### Returns

`string`

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

Defined in: contexts/index.d.ts:926

File size

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

Defined in: contexts/index.d.ts:334

Unique identifier for this file, which is supposed to be the same over
time and for different bots. Can't be used to download or reuse the file.

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileUniqueId`](FileAttachment.md#fileuniqueid)

***

### height

#### Get Signature

> **get** **height**(): `number`

Defined in: contexts/index.d.ts:916

Video height as defined by sender

##### Returns

`number`

***

### mimeType

#### Get Signature

> **get** **mimeType**(): `string`

Defined in: contexts/index.d.ts:924

Mime type of a file as defined by sender

##### Returns

`string`

***

### qualities

#### Get Signature

> **get** **qualities**(): [`VideoQuality`](VideoQuality.md)\[]

Defined in: contexts/index.d.ts:932

*Optional*. List of available qualities of the video

##### Returns

[`VideoQuality`](VideoQuality.md)\[]

***

### startTimestamp

#### Get Signature

> **get** **startTimestamp**(): `number`

Defined in: contexts/index.d.ts:930

Start timestamp

##### Returns

`number`

***

### thumbnail

#### Get Signature

> **get** **thumbnail**(): [`PhotoSize`](PhotoSize.md)

Defined in: contexts/index.d.ts:920

Video thumbnail

##### Returns

[`PhotoSize`](PhotoSize.md)

***

### width

#### Get Signature

> **get** **width**(): `number`

Defined in: contexts/index.d.ts:914

Video width as defined by sender

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/VideoChatEnded.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VideoChatEnded

# Class: VideoChatEnded

Defined in: contexts/index.d.ts:2327

This object represents a service message about a video chat ended in the chat.

## Constructors

### Constructor

> **new VideoChatEnded**(`payload`): `VideoChatEnded`

Defined in: contexts/index.d.ts:2329

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramVideoChatEnded`](../../../../gramio/interfaces/TelegramVideoChatEnded.md) |

#### Returns

`VideoChatEnded`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramVideoChatEnded`](../../../../gramio/interfaces/TelegramVideoChatEnded.md) | contexts/index.d.ts:2328 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2331

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### duration

#### Get Signature

> **get** **duration**(): `number`

Defined in: contexts/index.d.ts:2333

Video chat duration; in seconds

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/VideoChatEndedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VideoChatEndedContext

# Class: VideoChatEndedContext\<Bot>

Defined in: contexts/index.d.ts:6578

This object represents a service message about a video chat ended in the chat.

[Documentation](https://core.telegram.org/bots/api/#videochatended)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`VideoChatEndedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `VideoChatEndedContext`<`Bot`>, `VideoChatEndedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new VideoChatEndedContext**<`Bot`>(`options`): `VideoChatEndedContext`<`Bot`>

Defined in: contexts/index.d.ts:6581

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `VideoChatEndedContextOptions`<`Bot`> |

#### Returns

`VideoChatEndedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new VideoChatEndedContext**(...`args`): `VideoChatEndedContext`

Defined in: contexts/index.d.ts:6578

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`VideoChatEndedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6580 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventEnded

#### Get Signature

> **get** **eventEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:6583

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `VideoChatEndedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `VideoChatEndedContextOptions` |

#### Returns

`VideoChatEndedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<VideoChatEndedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<VideoChatEndedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<VideoChatEndedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<VideoChatEndedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<VideoChatEndedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<VideoChatEndedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<VideoChatEndedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<VideoChatEndedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<VideoChatEndedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<VideoChatEndedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<VideoChatEndedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<VideoChatEndedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/VideoChatParticipantsInvited.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VideoChatParticipantsInvited

# Class: VideoChatParticipantsInvited

Defined in: contexts/index.d.ts:2337

This object represents a service message about new members invited to a video chat.

## Constructors

### Constructor

> **new VideoChatParticipantsInvited**(`payload`): `VideoChatParticipantsInvited`

Defined in: contexts/index.d.ts:2339

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramVideoChatParticipantsInvited`](../../../../gramio/interfaces/TelegramVideoChatParticipantsInvited.md) |

#### Returns

`VideoChatParticipantsInvited`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramVideoChatParticipantsInvited`](../../../../gramio/interfaces/TelegramVideoChatParticipantsInvited.md) | contexts/index.d.ts:2338 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2341

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### users

#### Get Signature

> **get** **users**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:2343

New members that were invited to the video chat

##### Returns

[`User`](User.md)\[]

---

---
url: 'https://gramio.dev/api/contexts/classes/VideoChatParticipantsInvitedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VideoChatParticipantsInvitedContext

# Class: VideoChatParticipantsInvitedContext\<Bot>

Defined in: contexts/index.d.ts:6599

This object represents a service message about new members invited to a video chat.

[Documentation](https://core.telegram.org/bots/api/#videochatparticipantsinvited)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`VideoChatParticipantsInvitedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `VideoChatParticipantsInvitedContext`<`Bot`>, `VideoChatParticipantsInvitedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new VideoChatParticipantsInvitedContext**<`Bot`>(`options`): `VideoChatParticipantsInvitedContext`<`Bot`>

Defined in: contexts/index.d.ts:6602

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `VideoChatParticipantsInvitedContextOptions`<`Bot`> |

#### Returns

`VideoChatParticipantsInvitedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new VideoChatParticipantsInvitedContext**(...`args`): `VideoChatParticipantsInvitedContext`

Defined in: contexts/index.d.ts:6599

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`VideoChatParticipantsInvitedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6601 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventParticipantsInvited

#### Get Signature

> **get** **eventParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:6604

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `VideoChatParticipantsInvitedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `VideoChatParticipantsInvitedContextOptions` |

#### Returns

`VideoChatParticipantsInvitedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<VideoChatParticipantsInvitedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<VideoChatParticipantsInvitedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<VideoChatParticipantsInvitedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<VideoChatParticipantsInvitedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<VideoChatParticipantsInvitedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<VideoChatParticipantsInvitedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<VideoChatParticipantsInvitedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<VideoChatParticipantsInvitedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<VideoChatParticipantsInvitedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<VideoChatParticipantsInvitedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<VideoChatParticipantsInvitedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<VideoChatParticipantsInvitedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/VideoChatScheduled.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VideoChatScheduled

# Class: VideoChatScheduled

Defined in: contexts/index.d.ts:2349

This object represents a service message about a video chat scheduled in the chat

## Constructors

### Constructor

> **new VideoChatScheduled**(`payload`): `VideoChatScheduled`

Defined in: contexts/index.d.ts:2351

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramVideoChatScheduled`](../../../../gramio/interfaces/TelegramVideoChatScheduled.md) |

#### Returns

`VideoChatScheduled`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramVideoChatScheduled`](../../../../gramio/interfaces/TelegramVideoChatScheduled.md) | contexts/index.d.ts:2350 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2353

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### startDate

#### Get Signature

> **get** **startDate**(): `number`

Defined in: contexts/index.d.ts:2355

Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/VideoChatScheduledContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VideoChatScheduledContext

# Class: VideoChatScheduledContext\<Bot>

Defined in: contexts/index.d.ts:6620

This object represents a service message about a video chat scheduled in the chat.

[Documentation](https://core.telegram.org/bots/api/#videochatscheduled)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`VideoChatScheduledContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `VideoChatScheduledContext`<`Bot`>, `VideoChatScheduledContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new VideoChatScheduledContext**<`Bot`>(`options`): `VideoChatScheduledContext`<`Bot`>

Defined in: contexts/index.d.ts:6623

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `VideoChatScheduledContextOptions`<`Bot`> |

#### Returns

`VideoChatScheduledContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new VideoChatScheduledContext**(...`args`): `VideoChatScheduledContext`

Defined in: contexts/index.d.ts:6620

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`VideoChatScheduledContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6622 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventScheduled

#### Get Signature

> **get** **eventScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:6625

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `VideoChatScheduledContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `VideoChatScheduledContextOptions` |

#### Returns

`VideoChatScheduledContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<VideoChatScheduledContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<VideoChatScheduledContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<VideoChatScheduledContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<VideoChatScheduledContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<VideoChatScheduledContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<VideoChatScheduledContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<VideoChatScheduledContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<VideoChatScheduledContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<VideoChatScheduledContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<VideoChatScheduledContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<VideoChatScheduledContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<VideoChatScheduledContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/VideoChatStarted.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VideoChatStarted

# Class: VideoChatStarted

Defined in: contexts/index.d.ts:2362

This object represents a service message about a video chat started in the chat.
Currently holds no information.

## Constructors

### Constructor

> **new VideoChatStarted**(`payload`): `VideoChatStarted`

Defined in: contexts/index.d.ts:2364

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramVideoChatStarted`](../../../../gramio/interfaces/TelegramVideoChatStarted.md) |

#### Returns

`VideoChatStarted`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramVideoChatStarted`](../../../../gramio/interfaces/TelegramVideoChatStarted.md) | contexts/index.d.ts:2363 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2366

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/VideoChatStartedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VideoChatStartedContext

# Class: VideoChatStartedContext\<Bot>

Defined in: contexts/index.d.ts:6641

This object represents a service message about a video chat started in the chat.

[Documentation](https://core.telegram.org/bots/api/#videochatstarted)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`VideoChatStartedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatInviteControlMixin`](ChatInviteControlMixin.md)<`Bot`>.[`ChatControlMixin`](ChatControlMixin.md)<`Bot`>.[`ChatSenderControlMixin`](ChatSenderControlMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `VideoChatStartedContext`<`Bot`>, `VideoChatStartedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new VideoChatStartedContext**<`Bot`>(`options`): `VideoChatStartedContext`<`Bot`>

Defined in: contexts/index.d.ts:6644

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `VideoChatStartedContextOptions`<`Bot`> |

#### Returns

`VideoChatStartedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new VideoChatStartedContext**(...`args`): `VideoChatStartedContext`

Defined in: contexts/index.d.ts:6641

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`VideoChatStartedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6643 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventStarted

#### Get Signature

> **get** **eventStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:6646

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### banChatSender()

> **banChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5148

Bans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatSenderChatParams`](../../../../gramio/interfaces/BanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`banChatSender`](ChatSenderControlMixin.md#banchatsender)

***

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5132

Bans a user (o\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`BanChatMemberParams`](../../../../gramio/interfaces/BanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`banMember`](ChatMemberControlMixin.md#banmember)

***

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `VideoChatStartedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `VideoChatStartedContextOptions` |

#### Returns

`VideoChatStartedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### createInviteLink()

> **createInviteLink**(`params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5120

Creates an additional invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CreateChatInviteLinkParams`](../../../../gramio/interfaces/CreateChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`createInviteLink`](ChatInviteControlMixin.md#createinvitelink)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteChatStickerSet()

> **deleteChatStickerSet**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5110

Deletes group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatStickerSetParams`](../../../../gramio/interfaces/DeleteChatStickerSetParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`deleteChatStickerSet`](ChatControlMixin.md#deletechatstickerset)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5122

Edits non-primary invite link created by the bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`EditChatInviteLinkParams`](../../../../gramio/interfaces/EditChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`editInviteLink`](ChatInviteControlMixin.md#editinvitelink)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### exportInviteLink()

> **exportInviteLink**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5118

Generates new primary invite link

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ExportChatInviteLinkParams`](../../../../gramio/interfaces/ExportChatInviteLinkParams.md), `"chat_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`exportInviteLink`](ChatInviteControlMixin.md#exportinvitelink)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<VideoChatStartedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<VideoChatStartedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<VideoChatStartedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<VideoChatStartedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<VideoChatStartedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<VideoChatStartedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<VideoChatStartedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<VideoChatStartedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<VideoChatStartedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<VideoChatStartedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<VideoChatStartedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<VideoChatStartedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### promoteMember()

> **promoteMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5138

Promotes/demotes a user (o\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PromoteChatMemberParams`](../../../../gramio/interfaces/PromoteChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`promoteMember`](ChatMemberControlMixin.md#promotemember)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### removeChatPhoto()

> **removeChatPhoto**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5102

Deletes a chat photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteChatPhotoParams`](../../../../gramio/interfaces/DeleteChatPhotoParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`removeChatPhoto`](ChatControlMixin.md#removechatphoto)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### restrictMember()

> **restrictMember**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5136

Restricts a user (O\_O)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RestrictChatMemberParams`](../../../../gramio/interfaces/RestrictChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`restrictMember`](ChatMemberControlMixin.md#restrictmember)

***

### revokeInviteLink()

> **revokeInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

Defined in: contexts/index.d.ts:5124

Revokes an invite link generated by a bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `link` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`RevokeChatInviteLinkParams`](../../../../gramio/interfaces/RevokeChatInviteLinkParams.md), `"chat_id"` | `"invite_link"`> |

#### Returns

`Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

#### Inherited from

[`ChatInviteControlMixin`](ChatInviteControlMixin.md).[`revokeInviteLink`](ChatInviteControlMixin.md#revokeinvitelink)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setChatDefaultPermissions()

> **setChatDefaultPermissions**(`permissions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5098

Sets default chat permissions

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | [`TelegramChatPermissions`](../../../../gramio/interfaces/TelegramChatPermissions.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPermissionsParams`](../../../../gramio/interfaces/SetChatPermissionsParams.md), `"chat_id"` | `"permissions"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDefaultPermissions`](ChatControlMixin.md#setchatdefaultpermissions)

***

### setChatDescription()

> **setChatDescription**(`description`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5106

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"chat_id"` | `"description"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5100

Sets a new profile photo for the chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatPhotoParams`](../../../../gramio/interfaces/SetChatPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatPhoto`](ChatControlMixin.md#setchatphoto)

***

### setChatStickerSet()

> **setChatStickerSet**(`name`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5108

Sets new group stickerset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatStickerSetParams`](../../../../gramio/interfaces/SetChatStickerSetParams.md), `"chat_id"` | `"sticker_set_name"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatStickerSet`](ChatControlMixin.md#setchatstickerset)

***

### setChatTitle()

> **setChatTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5104

Changes chat title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatTitleParams`](../../../../gramio/interfaces/SetChatTitleParams.md), `"title"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatTitle`](ChatControlMixin.md#setchattitle)

***

### setCustomTitle()

> **setCustomTitle**(`title`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5096

Sets a custom title

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `title` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatAdministratorCustomTitleParams`](../../../../gramio/interfaces/SetChatAdministratorCustomTitleParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setCustomTitle`](ChatControlMixin.md#setcustomtitle)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5140

Sets a tag for a regular member

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tag` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatMemberTagParams`](../../../../gramio/interfaces/SetChatMemberTagParams.md), `"chat_id"` | `"user_id"` | `"tag"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`setMemberTag`](ChatMemberControlMixin.md#setmembertag)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unbanChatSender()

> **unbanChatSender**(`senderChatId`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5150

Unbans a channel chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `senderChatId` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatSenderChatParams`](../../../../gramio/interfaces/UnbanChatSenderChatParams.md), `"chat_id"` | `"sender_chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatSenderControlMixin`](ChatSenderControlMixin.md).[`unbanChatSender`](ChatSenderControlMixin.md#unbanchatsender)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5134

Unbans a user (O\_o)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnbanChatMemberParams`](../../../../gramio/interfaces/UnbanChatMemberParams.md), `"chat_id"` | `"user_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`unbanMember`](ChatMemberControlMixin.md#unbanmember)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/VideoNoteAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VideoNoteAttachment

# Class: VideoNoteAttachment

Defined in: contexts/index.d.ts:859

This object represents a video message.

## Extends

* [`FileAttachment`](FileAttachment.md)<[`TelegramVideoNote`](../../../../gramio/interfaces/TelegramVideoNote.md)>

## Constructors

### Constructor

> **new VideoNoteAttachment**(`payload`): `VideoNoteAttachment`

Defined in: contexts/index.d.ts:327

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramVideoNote`](../../../../gramio/interfaces/TelegramVideoNote.md) |

#### Returns

`VideoNoteAttachment`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`constructor`](FileAttachment.md#constructor)

## Properties

| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|  `attachmentType` | `public` | [`AttachmentType`](../type-aliases/AttachmentType.md) | Returns attachment's type (e.g. `'audio'`, `'photo'`) | [`FileAttachment`](FileAttachment.md).[`attachmentType`](FileAttachment.md#attachmenttype) | - | contexts/index.d.ts:860 |
|  `payload` | `protected` | [`TelegramVideoNote`](../../../../gramio/interfaces/TelegramVideoNote.md) | - | - | [`FileAttachment`](FileAttachment.md).[`payload`](FileAttachment.md#payload) | contexts/index.d.ts:324 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:314

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`[toStringTag]`](FileAttachment.md#tostringtag)

***

### duration

#### Get Signature

> **get** **duration**(): `number`

Defined in: contexts/index.d.ts:867

Duration of the video in seconds as defined by sender

##### Returns

`number`

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

Defined in: contexts/index.d.ts:329

Identifier for this file, which can be used to download or reuse the file

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileId`](FileAttachment.md#fileid)

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

Defined in: contexts/index.d.ts:871

File size

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

Defined in: contexts/index.d.ts:334

Unique identifier for this file, which is supposed to be the same over
time and for different bots. Can't be used to download or reuse the file.

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileUniqueId`](FileAttachment.md#fileuniqueid)

***

### length

#### Get Signature

> **get** **length**(): `number`

Defined in: contexts/index.d.ts:865

Video width and height (diameter of the video message) as defined by
sender

##### Returns

`number`

***

### thumbnail

#### Get Signature

> **get** **thumbnail**(): [`PhotoSize`](PhotoSize.md)

Defined in: contexts/index.d.ts:869

Video thumbnail

##### Returns

[`PhotoSize`](PhotoSize.md)

---

---
url: 'https://gramio.dev/api/contexts/classes/VideoQuality.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VideoQuality

# Class: VideoQuality

Defined in: contexts/index.d.ts:879

This object represents a video file of a specific quality.

[Documentation](https://core.telegram.org/bots/api/#videoquality)

## Constructors

### Constructor

> **new VideoQuality**(`payload`): `VideoQuality`

Defined in: contexts/index.d.ts:881

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramVideoQuality`](../../../../gramio/interfaces/TelegramVideoQuality.md) |

#### Returns

`VideoQuality`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramVideoQuality`](../../../../gramio/interfaces/TelegramVideoQuality.md) | contexts/index.d.ts:880 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:883

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### codec

#### Get Signature

> **get** **codec**(): [`TelegramVideoQualityCodec`](../../../../gramio/type-aliases/TelegramVideoQualityCodec.md)

Defined in: contexts/index.d.ts:903

Codec that was used to encode the video, for example, "h264", "h265", or "av01"

##### Returns

[`TelegramVideoQualityCodec`](../../../../gramio/type-aliases/TelegramVideoQualityCodec.md)

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

Defined in: contexts/index.d.ts:887

Identifier for this file, which can be used to download or reuse the file

##### Returns

`string`

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

Defined in: contexts/index.d.ts:907

*Optional*. File size in bytes

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

Defined in: contexts/index.d.ts:891

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

##### Returns

`string`

***

### height

#### Get Signature

> **get** **height**(): `number`

Defined in: contexts/index.d.ts:899

Video height

##### Returns

`number`

***

### width

#### Get Signature

> **get** **width**(): `number`

Defined in: contexts/index.d.ts:895

Video width

##### Returns

`number`

---

---
url: 'https://gramio.dev/api/contexts/classes/VoiceAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / VoiceAttachment

# Class: VoiceAttachment

Defined in: contexts/index.d.ts:936

This object represents a voice note.

## Extends

* [`FileAttachment`](FileAttachment.md)<[`TelegramVoice`](../../../../gramio/interfaces/TelegramVoice.md)>

## Constructors

### Constructor

> **new VoiceAttachment**(`payload`): `VoiceAttachment`

Defined in: contexts/index.d.ts:327

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramVoice`](../../../../gramio/interfaces/TelegramVoice.md) |

#### Returns

`VoiceAttachment`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`constructor`](FileAttachment.md#constructor)

## Properties

| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|  `attachmentType` | `public` | [`AttachmentType`](../type-aliases/AttachmentType.md) | Returns attachment's type (e.g. `'audio'`, `'photo'`) | [`FileAttachment`](FileAttachment.md).[`attachmentType`](FileAttachment.md#attachmenttype) | - | contexts/index.d.ts:937 |
|  `payload` | `protected` | [`TelegramVoice`](../../../../gramio/interfaces/TelegramVoice.md) | - | - | [`FileAttachment`](FileAttachment.md).[`payload`](FileAttachment.md#payload) | contexts/index.d.ts:324 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:314

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`[toStringTag]`](FileAttachment.md#tostringtag)

***

### duration

#### Get Signature

> **get** **duration**(): `number`

Defined in: contexts/index.d.ts:939

Duration of the audio in seconds as defined by sender

##### Returns

`number`

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

Defined in: contexts/index.d.ts:329

Identifier for this file, which can be used to download or reuse the file

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileId`](FileAttachment.md#fileid)

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

Defined in: contexts/index.d.ts:943

File size

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

Defined in: contexts/index.d.ts:334

Unique identifier for this file, which is supposed to be the same over
time and for different bots. Can't be used to download or reuse the file.

##### Returns

`string`

#### Inherited from

[`FileAttachment`](FileAttachment.md).[`fileUniqueId`](FileAttachment.md#fileuniqueid)

***

### mimeType

#### Get Signature

> **get** **mimeType**(): `string`

Defined in: contexts/index.d.ts:941

MIME type of the file as defined by sender

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/WebAppData.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / WebAppData

# Class: WebAppData

Defined in: contexts/index.d.ts:2370

Contains data sent from a Web App to the bot.

## Constructors

### Constructor

> **new WebAppData**(`payload`): `WebAppData`

Defined in: contexts/index.d.ts:2372

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramWebAppData`](../../../../gramio/interfaces/TelegramWebAppData.md) |

#### Returns

`WebAppData`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramWebAppData`](../../../../gramio/interfaces/TelegramWebAppData.md) | contexts/index.d.ts:2371 |

## Accessors

### buttonText

#### Get Signature

> **get** **buttonText**(): `string`

Defined in: contexts/index.d.ts:2379

Text of the `web_app` keyboard button, from which the Web App was opened.
Be aware that a bad client can send arbitrary data in this field.

##### Returns

`string`

***

### data

#### Get Signature

> **get** **data**(): `string`

Defined in: contexts/index.d.ts:2374

The data. Be aware that a bad client can send arbitrary data in this field.

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/WebAppDataContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / WebAppDataContext

# Class: WebAppDataContext\<Bot>

Defined in: contexts/index.d.ts:6662

Describes data sent from a [Web App](https://core.telegram.org/bots/webapps) to the bot.

[Documentation](https://core.telegram.org/bots/api/#webappdata)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`WebAppDataContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `WebAppDataContext`<`Bot`>, `WebAppDataContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new WebAppDataContext**<`Bot`>(`options`): `WebAppDataContext`<`Bot`>

Defined in: contexts/index.d.ts:6665

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `WebAppDataContextOptions`<`Bot`> |

#### Returns

`WebAppDataContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new WebAppDataContext**(...`args`): `WebAppDataContext`

Defined in: contexts/index.d.ts:6662

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`WebAppDataContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6664 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### buttonText

#### Get Signature

> **get** **buttonText**(): `string`

Defined in: contexts/index.d.ts:6672

Text of the `web_app` keyboard button, from which the Web App was opened.
Be aware that a bad client can send arbitrary data in this field.

##### Returns

`string`

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### data

#### Get Signature

> **get** **data**(): `string`

Defined in: contexts/index.d.ts:6667

The data. Be aware that a bad client can send arbitrary data in this field.

##### Returns

`string`

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `WebAppDataContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `WebAppDataContextOptions` |

#### Returns

`WebAppDataContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<WebAppDataContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<WebAppDataContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<WebAppDataContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<WebAppDataContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<WebAppDataContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<WebAppDataContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<WebAppDataContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<WebAppDataContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<WebAppDataContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<WebAppDataContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<WebAppDataContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<WebAppDataContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

---

---
url: 'https://gramio.dev/api/contexts/classes/WebAppInfo.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / WebAppInfo

# Class: WebAppInfo

Defined in: contexts/index.d.ts:4218

Contains information about a Web App.

## Constructors

### Constructor

> **new WebAppInfo**(`payload`): `WebAppInfo`

Defined in: contexts/index.d.ts:4220

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramWebAppInfo`](../../../../gramio/interfaces/TelegramWebAppInfo.md) |

#### Returns

`WebAppInfo`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramWebAppInfo`](../../../../gramio/interfaces/TelegramWebAppInfo.md) | contexts/index.d.ts:4219 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4222

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### url

#### Get Signature

> **get** **url**(): `string`

Defined in: contexts/index.d.ts:4224

An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/WriteAccessAllowed.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / WriteAccessAllowed

# Class: WriteAccessAllowed

Defined in: contexts/index.d.ts:2383

This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information.

## Constructors

### Constructor

> **new WriteAccessAllowed**(`payload`): `WriteAccessAllowed`

Defined in: contexts/index.d.ts:2385

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramWriteAccessAllowed`](../../../../gramio/interfaces/TelegramWriteAccessAllowed.md) |

#### Returns

`WriteAccessAllowed`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramWriteAccessAllowed`](../../../../gramio/interfaces/TelegramWriteAccessAllowed.md) | contexts/index.d.ts:2384 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2387

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### fromAttachmentMenu

#### Get Signature

> **get** **fromAttachmentMenu**(): `string`

Defined in: contexts/index.d.ts:2393

`true`, if the access was granted when the bot was added to the attachment or side menu

##### Returns

`string`

***

### fromRequest

#### Get Signature

> **get** **fromRequest**(): `boolean`

Defined in: contexts/index.d.ts:2389

`true`, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess

##### Returns

`boolean`

***

### webAppName

#### Get Signature

> **get** **webAppName**(): `string`

Defined in: contexts/index.d.ts:2391

Name of the Web App which was launched from a link

##### Returns

`string`

---

---
url: 'https://gramio.dev/api/contexts/classes/WriteAccessAllowedContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / WriteAccessAllowedContext

# Class: WriteAccessAllowedContext\<Bot>

Defined in: contexts/index.d.ts:6688

This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method [requestWriteAccess](https://core.telegram.org/bots/webapps#initializing-mini-apps).

[Documentation](https://core.telegram.org/bots/api/#writeaccessallowed)

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`WriteAccessAllowedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `WriteAccessAllowedContext`<`Bot`>, `WriteAccessAllowedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new WriteAccessAllowedContext**<`Bot`>(`options`): `WriteAccessAllowedContext`<`Bot`>

Defined in: contexts/index.d.ts:6691

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `WriteAccessAllowedContextOptions`<`Bot`> |

#### Returns

`WriteAccessAllowedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new WriteAccessAllowedContext**(...`args`): `WriteAccessAllowedContext`

Defined in: contexts/index.d.ts:6688

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`WriteAccessAllowedContext`

#### Overrides

`Context<Bot>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | - | [`Context`](Context.md).[`bot`](Context.md#bot-1) | contexts/index.d.ts:4726 |
|  `payload` | `public` | [`TelegramMessage`](../../../../gramio/interfaces/TelegramMessage.md) | The raw data that is used for this Context | [`Message`](Message.md).[`payload`](Message.md#payload) | contexts/index.d.ts:6690 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4728 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4727 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4729 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4732

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

#### Inherited from

[`Context`](Context.md).[`[toStringTag]`](Context.md#tostringtag)

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

Defined in: contexts/index.d.ts:2997

Message is an animation, information about the animation. For backward
compatibility, when this field is set, the `document` field will also be set

##### Returns

[`AnimationAttachment`](AnimationAttachment.md)

#### Inherited from

[`Message`](Message.md).[`animation`](Message.md#animation)

***

### audio

#### Get Signature

> **get** **audio**(): [`AudioAttachment`](AudioAttachment.md)

Defined in: contexts/index.d.ts:2999

Message is an audio file, information about the file

##### Returns

[`AudioAttachment`](AudioAttachment.md)

#### Inherited from

[`Message`](Message.md).[`audio`](Message.md#audio)

***

### authorSignature

#### Get Signature

> **get** **authorSignature**(): `string`

Defined in: contexts/index.d.ts:2973

Signature of the post author for messages in channels,
or the custom title of an anonymous group administrator

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`authorSignature`](Message.md#authorsignature)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:2937

Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`businessConnectionId`](Message.md#businessconnectionid)

***

### caption

#### Get Signature

> **get** **caption**(): `string`

Defined in: contexts/index.d.ts:3018

Caption for the animation, audio, document, photo, video or voice,
0-1024 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`caption`](Message.md#caption)

***

### captionEntities

#### Get Signature

> **get** **captionEntities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:3023

For messages with a caption, special entities like usernames, URLs, bot
commands, etc. that appear in the caption

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`captionEntities`](Message.md#captionentities)

***

### channelChatCreated

#### Get Signature

> **get** **channelChatCreated**(): `true`

Defined in: contexts/index.d.ts:3094

Service message: the channel has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a channel when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a channel.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`channelChatCreated`](Message.md#channelchatcreated)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2939

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`chat`](Message.md#chat)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

Defined in: contexts/index.d.ts:3145

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

#### Inherited from

[`Message`](Message.md).[`chatBackgroundSet`](Message.md#chatbackgroundset)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

Defined in: contexts/index.d.ts:3143

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

#### Inherited from

[`Message`](Message.md).[`chatBoostAdded`](Message.md#chatboostadded)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4763

Chat ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatId`](TargetMixin.md#chatid)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

Defined in: contexts/index.d.ts:3069

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerChanged`](Message.md#chatownerchanged)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

Defined in: contexts/index.d.ts:3067

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

#### Inherited from

[`Message`](Message.md).[`chatOwnerLeft`](Message.md#chatownerleft)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

Defined in: contexts/index.d.ts:3127

Service message: a chat was shared with the bot

##### Returns

[`ChatShared`](ChatShared.md)

#### Inherited from

[`Message`](Message.md).[`chatShared`](Message.md#chatshared)

***

### chatType

#### Get Signature

> **get** **chatType**(): [`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

Defined in: contexts/index.d.ts:4767

Chat type

##### Returns

[`TelegramChatType`](../../../../gramio/type-aliases/TelegramChatType.md)

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`chatType`](TargetMixin.md#chattype)

***

### checklist

#### Get Signature

> **get** **checklist**(): [`Checklist`](Checklist.md)

Defined in: contexts/index.d.ts:2952

##### Returns

[`Checklist`](Checklist.md)

#### Inherited from

[`Message`](Message.md).[`checklist`](Message.md#checklist)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

Defined in: contexts/index.d.ts:3150

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksAdded`](Message.md#checklisttasksadded)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

Defined in: contexts/index.d.ts:3147

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

#### Inherited from

[`Message`](Message.md).[`checklistTasksDone`](Message.md#checklisttasksdone)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

Defined in: contexts/index.d.ts:3053

The domain name of the website on which the user has logged in.

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`connectedWebsite`](Message.md#connectedwebsite)

***

### contact

#### Get Signature

> **get** **contact**(): [`Contact`](Contact.md)

Defined in: contexts/index.d.ts:3031

Message is a shared contact, information about the contact

##### Returns

[`Contact`](Contact.md)

#### Inherited from

[`Message`](Message.md).[`contact`](Message.md#contact)

***

### createdAt

#### Get Signature

> **get** **createdAt**(): `number`

Defined in: contexts/index.d.ts:2935

Date the message was sent in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`createdAt`](Message.md#createdat)

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

Defined in: contexts/index.d.ts:3075

Service message: the chat photo was deleted

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`deleteChatPhoto`](Message.md#deletechatphoto)

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

Defined in: contexts/index.d.ts:3033

Message is a dice with random value from 1 to 6

##### Returns

[`Dice`](Dice.md)

#### Inherited from

[`Message`](Message.md).[`dice`](Message.md#dice)

***

### directMessagePriceChanged

#### Get Signature

> **get** **directMessagePriceChanged**(): [`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

Defined in: contexts/index.d.ts:3152

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

#### Inherited from

[`Message`](Message.md).[`directMessagePriceChanged`](Message.md#directmessagepricechanged)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

Defined in: contexts/index.d.ts:2918

*Optional*. Information about the direct messages chat topic that contains the message

##### Returns

[`DirectMessagesTopic`](DirectMessagesTopic.md)

#### Inherited from

[`Message`](Message.md).[`directMessagesTopic`](Message.md#directmessagestopic)

***

### document

#### Get Signature

> **get** **document**(): [`DocumentAttachment`](DocumentAttachment.md)

Defined in: contexts/index.d.ts:3001

Message is a general file, information about the file

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

#### Inherited from

[`Message`](Message.md).[`document`](Message.md#document)

***

### effectId

#### Get Signature

> **get** **effectId**(): `string`

Defined in: contexts/index.d.ts:2992

Unique identifier of the message effect added to the message

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`effectId`](Message.md#effectid)

***

### entities

#### Get Signature

> **get** **entities**(): [`MessageEntity`](MessageEntity.md)\[]

Defined in: contexts/index.d.ts:2986

For text messages, special entities like usernames, URLs, bot commands,
etc. that appear in the text

##### Returns

[`MessageEntity`](MessageEntity.md)\[]

#### Inherited from

[`Message`](Message.md).[`entities`](Message.md#entities)

***

### eventAllowance

#### Get Signature

> **get** **eventAllowance**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:6693

Service message: user allows a bot to write messages after adding it to the attachment menu

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:2954

Information about the message that is being replied to, which may come from another chat or forum topic

##### Returns

[`ExternalReplyInfo`](ExternalReplyInfo.md)

#### Inherited from

[`Message`](Message.md).[`externalReply`](Message.md#externalreply)

***

### forumTopicClosed

#### Get Signature

> **get** **forumTopicClosed**(): [`ForumTopicClosed`](ForumTopicClosed.md)

Defined in: contexts/index.d.ts:3168

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicClosed`](Message.md#forumtopicclosed)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

Defined in: contexts/index.d.ts:3164

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicCreated`](Message.md#forumtopiccreated)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

Defined in: contexts/index.d.ts:3166

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicEdited`](Message.md#forumtopicedited)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

Defined in: contexts/index.d.ts:3170

Service message: forum topic reopened

##### Returns

[`ForumTopicReopened`](ForumTopicReopened.md)

#### Inherited from

[`Message`](Message.md).[`forumTopicReopened`](Message.md#forumtopicreopened)

***

### forwardOrigin

#### Get Signature

> **get** **forwardOrigin**(): [`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

Defined in: contexts/index.d.ts:2941

Information about the original message for forwarded messages

##### Returns

[`MessageOriginUser`](MessageOriginUser.md) | [`MessageOriginChat`](MessageOriginChat.md) | [`MessageOriginChannel`](MessageOriginChannel.md) | [`MessageOriginHiddenUser`](MessageOriginHiddenUser.md)

#### Inherited from

[`Message`](Message.md).[`forwardOrigin`](Message.md#forwardorigin)

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2920

Sender, empty for messages sent to channels

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`from`](Message.md#from)

***

### game

#### Get Signature

> **get** **game**(): [`Game`](Game.md)

Defined in: contexts/index.d.ts:3035

Message is a game, information about the game

##### Returns

[`Game`](Game.md)

#### Inherited from

[`Message`](Message.md).[`game`](Message.md#game)

***

### generalForumTopicHidden

#### Get Signature

> **get** **generalForumTopicHidden**(): [`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

Defined in: contexts/index.d.ts:3172

Service message: the 'General' forum topic hidden

##### Returns

[`GeneralForumTopicHidden`](GeneralForumTopicHidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicHidden`](Message.md#generalforumtopichidden)

***

### generalForumTopicUnhidden

#### Get Signature

> **get** **generalForumTopicUnhidden**(): [`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

Defined in: contexts/index.d.ts:3174

Service message: the 'General' forum topic unhidden

##### Returns

[`GeneralForumTopicUnhidden`](GeneralForumTopicUnhidden.md)

#### Inherited from

[`Message`](Message.md).[`generalForumTopicUnhidden`](Message.md#generalforumtopicunhidden)

***

### gift

#### Get Signature

> **get** **gift**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3129

Service message: a gift was sent to the chat

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`gift`](Message.md#gift)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

Defined in: contexts/index.d.ts:3131

Service message: upgrade of a gift was purchased after the gift was sent

##### Returns

[`GiftInfo`](GiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`giftUpgradeSent`](Message.md#giftupgradesent)

***

### giveaway

#### Get Signature

> **get** **giveaway**(): [`Giveaway`](Giveaway.md)

Defined in: contexts/index.d.ts:3176

The message is a scheduled giveaway message

##### Returns

[`Giveaway`](Giveaway.md)

#### Inherited from

[`Message`](Message.md).[`giveaway`](Message.md#giveaway)

***

### giveawayCompleted

#### Get Signature

> **get** **giveawayCompleted**(): [`GiveawayCompleted`](GiveawayCompleted.md)

Defined in: contexts/index.d.ts:3180

Service message: a giveaway without public winners was completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCompleted`](Message.md#giveawaycompleted)

***

### giveawayCreated

#### Get Signature

> **get** **giveawayCreated**(): [`GiveawayCreated`](GiveawayCreated.md)

Defined in: contexts/index.d.ts:3178

Service message: a scheduled giveaway was created

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

#### Inherited from

[`Message`](Message.md).[`giveawayCreated`](Message.md#giveawaycreated)

***

### giveawayWinners

#### Get Signature

> **get** **giveawayWinners**(): [`GiveawayWinners`](GiveawayWinners.md)

Defined in: contexts/index.d.ts:3182

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

#### Inherited from

[`Message`](Message.md).[`giveawayWinners`](Message.md#giveawaywinners)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3077

Service message: the group has been created

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`groupChatCreated`](Message.md#groupchatcreated)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:2914

Unique message identifier inside this chat

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`id`](Message.md#id)

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

Defined in: contexts/index.d.ts:3118

Message is an invoice for a payment, information about the invoice

##### Returns

[`Invoice`](Invoice.md)

#### Inherited from

[`Message`](Message.md).[`invoice`](Message.md#invoice)

***

### leftChatMember

#### Get Signature

> **get** **leftChatMember**(): [`User`](User.md)

Defined in: contexts/index.d.ts:3065

A member was removed from the group, information about them (this member
may be the bot itself)

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`leftChatMember`](Message.md#leftchatmember)

***

### linkPreviewOptions

#### Get Signature

> **get** **linkPreviewOptions**(): [`LinkPreviewOptions`](LinkPreviewOptions.md)

Defined in: contexts/index.d.ts:2988

Options used for link preview generation for the message, if it is a text message and link preview options were changed

##### Returns

[`LinkPreviewOptions`](LinkPreviewOptions.md)

#### Inherited from

[`Message`](Message.md).[`linkPreviewOptions`](Message.md#linkpreviewoptions)

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

Defined in: contexts/index.d.ts:3045

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:2968

The unique identifier of a media message group this message belongs to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`mediaGroupId`](Message.md#mediagroupid)

***

### messageAutoDeleteTimerChanged

#### Get Signature

> **get** **messageAutoDeleteTimerChanged**(): [`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

Defined in: contexts/index.d.ts:3087

Service message: auto-delete timer settings changed in the chat

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

#### Inherited from

[`Message`](Message.md).[`messageAutoDeleteTimerChanged`](Message.md#messageautodeletetimerchanged)

***

### migrateFromChatId

#### Get Signature

> **get** **migrateFromChatId**(): `number`

Defined in: contexts/index.d.ts:3110

The supergroup has been migrated from a group with the specified
identifier. This number may be greater than 32 bits and some programming
languages may have difficulty/silent defects in interpreting it. But it is
smaller than 52 bits, so a signed 64 bit integer or double-precision float
type are safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateFromChatId`](Message.md#migratefromchatid)

***

### migrateToChatId

#### Get Signature

> **get** **migrateToChatId**(): `number`

Defined in: contexts/index.d.ts:3102

The group has been migrated to a supergroup with the specified identifier.
This number may be greater than 32 bits and some programming languages may
have difficulty/silent defects in interpreting it. But it is smaller than
52 bits, so a signed 64 bit integer or double-precision float type are
safe for storing this identifier.

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`migrateToChatId`](Message.md#migratetochatid)

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

Defined in: contexts/index.d.ts:3060

New members that were added to the group or supergroup and information
about them (the bot itself may be one of these members)

##### Returns

[`User`](User.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatMembers`](Message.md#newchatmembers)

***

### newChatPhoto

#### Get Signature

> **get** **newChatPhoto**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3073

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`newChatPhoto`](Message.md#newchatphoto)

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

Defined in: contexts/index.d.ts:3071

A chat title was changed to this value

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`newChatTitle`](Message.md#newchattitle)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:2977

*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`paidStarCount`](Message.md#paidstarcount)

***

### passportData

#### Get Signature

> **get** **passportData**(): [`PassportData`](PassportData.md)

Defined in: contexts/index.d.ts:3055

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

#### Inherited from

[`Message`](Message.md).[`passportData`](Message.md#passportdata)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

Defined in: contexts/index.d.ts:3003

Message is a photo, available sizes of the photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

#### Inherited from

[`Message`](Message.md).[`photo`](Message.md#photo)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

Defined in: contexts/index.d.ts:3116

Specified message was pinned. Note that the Message object in this field
will not contain further `replyMessage` fields even if it is itself a
reply.

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`> | [`InaccessibleMessage`](InaccessibleMessage.md)

#### Inherited from

[`Message`](Message.md).[`pinnedMessage`](Message.md#pinnedmessage)

***

### poll

#### Get Signature

> **get** **poll**(): [`Poll`](Poll.md)

Defined in: contexts/index.d.ts:3037

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3139

Service message.
A user in the chat triggered another user's proximity alert
while sharing Live Location.

##### Returns

[`ProximityAlertTriggered`](ProximityAlertTriggered.md)

#### Inherited from

[`Message`](Message.md).[`proximityAlertTriggered`](Message.md#proximityalerttriggered)

***

### quote

#### Get Signature

> **get** **quote**(): [`TextQuote`](TextQuote.md)

Defined in: contexts/index.d.ts:2956

For replies that quote part of the original message, the quoted part of the message

##### Returns

[`TextQuote`](TextQuote.md)

#### Inherited from

[`Message`](Message.md).[`quote`](Message.md#quote)

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3051

Inline keyboard attached to the message.

`login_url` buttons are represented as ordinary `url` buttons.

##### Returns

[`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

#### Inherited from

[`Message`](Message.md).[`replyMarkup`](Message.md#replymarkup)

***

### replyMessage

#### Get Signature

> **get** **replyMessage**(): `Omit`<[`Message`](Message.md), `"replyMessage"`>

Defined in: contexts/index.d.ts:2947

For replies, the original message

##### Returns

`Omit`<[`Message`](Message.md), `"replyMessage"`>

#### Inherited from

[`Message`](Message.md).[`replyMessage`](Message.md#replymessage)

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:2949

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

#### Inherited from

[`Message`](Message.md).[`replyStory`](Message.md#replystory)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:2951

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:2929

If the sender of the message boosted the chat, the number of boosts added by the user

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`senderBoostCount`](Message.md#senderboostcount)

***

### senderBusinessBot

#### Get Signature

> **get** **senderBusinessBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2931

The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`senderBusinessBot`](Message.md#senderbusinessbot)

***

### senderChat

#### Get Signature

> **get** **senderChat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:2927

Sender of the message, sent on behalf of a chat.
The channel itself for channel messages.
The supergroup itself for messages from anonymous group administrators.
The linked channel for messages automatically forwarded to the discussion group

##### Returns

[`Chat`](Chat.md)

#### Inherited from

[`Message`](Message.md).[`senderChat`](Message.md#senderchat)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4761

Sender's ID

##### Returns

`number`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`senderId`](TargetMixin.md#senderid)

***

### senderTag

#### Get Signature

> **get** **senderTag**(): `string`

Defined in: contexts/index.d.ts:2933

Tag or custom title of the sender of the message; for supergroups only

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`senderTag`](Message.md#sendertag)

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

Defined in: contexts/index.d.ts:3005

Message is a sticker, information about the sticker

##### Returns

[`StickerAttachment`](StickerAttachment.md)

#### Inherited from

[`Message`](Message.md).[`sticker`](Message.md#sticker)

***

### story

#### Get Signature

> **get** **story**(): [`StoryAttachment`](StoryAttachment.md)

Defined in: contexts/index.d.ts:3007

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

#### Inherited from

[`Message`](Message.md).[`story`](Message.md#story)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3123

Message is a service message about a successful payment,
information about the payment.

##### Returns

[`SuccessfulPayment`](SuccessfulPayment.md)

#### Inherited from

[`Message`](Message.md).[`successfulPayment`](Message.md#successfulpayment)

***

### suggestedPostApprovalFailed

#### Get Signature

> **get** **suggestedPostApprovalFailed**(): [`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

Defined in: contexts/index.d.ts:3156

Service message: approval of a suggested post has failed

##### Returns

[`SuggestedPostApprovalFailed`](SuggestedPostApprovalFailed.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApprovalFailed`](Message.md#suggestedpostapprovalfailed)

***

### suggestedPostApproved

#### Get Signature

> **get** **suggestedPostApproved**(): [`SuggestedPostApproved`](SuggestedPostApproved.md)

Defined in: contexts/index.d.ts:3154

Service message: a suggested post was approved

##### Returns

[`SuggestedPostApproved`](SuggestedPostApproved.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostApproved`](Message.md#suggestedpostapproved)

***

### suggestedPostDeclined

#### Get Signature

> **get** **suggestedPostDeclined**(): [`SuggestedPostDeclined`](SuggestedPostDeclined.md)

Defined in: contexts/index.d.ts:3158

Service message: a suggested post was declined

##### Returns

[`SuggestedPostDeclined`](SuggestedPostDeclined.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostDeclined`](Message.md#suggestedpostdeclined)

***

### suggestedPostInfo

#### Get Signature

> **get** **suggestedPostInfo**(): [`SuggestedPostInfo`](SuggestedPostInfo.md)

Defined in: contexts/index.d.ts:2990

*Optional*. Information about suggested post parameters if the message is a suggested post

##### Returns

[`SuggestedPostInfo`](SuggestedPostInfo.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostInfo`](Message.md#suggestedpostinfo)

***

### suggestedPostPaid

#### Get Signature

> **get** **suggestedPostPaid**(): [`SuggestedPostPaid`](SuggestedPostPaid.md)

Defined in: contexts/index.d.ts:3160

Service message: payment for a suggested post was received

##### Returns

[`SuggestedPostPaid`](SuggestedPostPaid.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostPaid`](Message.md#suggestedpostpaid)

***

### suggestedPostRefunded

#### Get Signature

> **get** **suggestedPostRefunded**(): [`SuggestedPostRefunded`](SuggestedPostRefunded.md)

Defined in: contexts/index.d.ts:3162

Service message: payment for a suggested post was refunded

##### Returns

[`SuggestedPostRefunded`](SuggestedPostRefunded.md)

#### Inherited from

[`Message`](Message.md).[`suggestedPostRefunded`](Message.md#suggestedpostrefunded)

***

### supergroupChatCreated

#### Get Signature

> **get** **supergroupChatCreated**(): `true`

Defined in: contexts/index.d.ts:3085

Service message: the supergroup has been created. This field can't be
received in a message coming through updates, because bot can't be a
member of a supergroup when it is created. It can only be found in
`replyMessage` if someone replies to a very first message in a
directly created supergroup.

##### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`supergroupChatCreated`](Message.md#supergroupchatcreated)

***

### text

#### Get Signature

> **get** **text**(): `string`

Defined in: contexts/index.d.ts:2981

For text messages, the actual UTF-8 text of the message, 0-4096 characters

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`text`](Message.md#text)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:2916

Unique identifier of a message thread to which the message belongs; for supergroups only

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`threadId`](Message.md#threadid)

***

### uniqueGift

#### Get Signature

> **get** **uniqueGift**(): [`UniqueGiftInfo`](UniqueGiftInfo.md)

Defined in: contexts/index.d.ts:3133

Service message: a unique gift was sent to the chat

##### Returns

[`UniqueGiftInfo`](UniqueGiftInfo.md)

#### Inherited from

[`Message`](Message.md).[`uniqueGift`](Message.md#uniquegift)

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

Defined in: contexts/index.d.ts:2960

Date the message was last edited in Unix time

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`updatedAt`](Message.md#updatedat)

***

### usersShared

#### Get Signature

> **get** **usersShared**(): [`UsersShared`](UsersShared.md)

Defined in: contexts/index.d.ts:3125

Service message: a user was shared with the bot

##### Returns

[`UsersShared`](UsersShared.md)

#### Inherited from

[`Message`](Message.md).[`usersShared`](Message.md#usersshared)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

Defined in: contexts/index.d.ts:3043

Message is a venue, information about the venue.
For backward compatibility, when this field is set,
the `location` field will also be set

##### Returns

[`Venue`](Venue.md)

#### Inherited from

[`Message`](Message.md).[`venue`](Message.md#venue)

***

### viaBot

#### Get Signature

> **get** **viaBot**(): [`User`](User.md)

Defined in: contexts/index.d.ts:2958

Bot through which the message was sent

##### Returns

[`User`](User.md)

#### Inherited from

[`Message`](Message.md).[`viaBot`](Message.md#viabot)

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:3009

Message is a video, information about the video

##### Returns

[`VideoAttachment`](VideoAttachment.md)

#### Inherited from

[`Message`](Message.md).[`video`](Message.md#video)

***

### videoChatEnded

#### Get Signature

> **get** **videoChatEnded**(): [`VideoChatEnded`](VideoChatEnded.md)

Defined in: contexts/index.d.ts:3188

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

#### Inherited from

[`Message`](Message.md).[`videoChatEnded`](Message.md#videochatended)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3190

Service message: new participants invited to a video chat

##### Returns

[`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

#### Inherited from

[`Message`](Message.md).[`videoChatParticipantsInvited`](Message.md#videochatparticipantsinvited)

***

### videoChatScheduled

#### Get Signature

> **get** **videoChatScheduled**(): [`VideoChatScheduled`](VideoChatScheduled.md)

Defined in: contexts/index.d.ts:3184

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

#### Inherited from

[`Message`](Message.md).[`videoChatScheduled`](Message.md#videochatscheduled)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3186

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

#### Inherited from

[`Message`](Message.md).[`videoChatStarted`](Message.md#videochatstarted)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3011

Message is a video note, information about the video message

##### Returns

[`VideoNoteAttachment`](VideoNoteAttachment.md)

#### Inherited from

[`Message`](Message.md).[`videoNote`](Message.md#videonote)

***

### voice

#### Get Signature

> **get** **voice**(): [`VoiceAttachment`](VoiceAttachment.md)

Defined in: contexts/index.d.ts:3013

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

#### Inherited from

[`Message`](Message.md).[`voice`](Message.md#voice)

***

### webAppData

#### Get Signature

> **get** **webAppData**(): [`WebAppData`](WebAppData.md)

Defined in: contexts/index.d.ts:3192

Service message: data sent by a Web App

##### Returns

[`WebAppData`](WebAppData.md)

#### Inherited from

[`Message`](Message.md).[`webAppData`](Message.md#webappdata)

***

### writeAccessAllowed

#### Get Signature

> **get** **writeAccessAllowed**(): [`WriteAccessAllowed`](WriteAccessAllowed.md)

Defined in: contexts/index.d.ts:3141

Service message: the user allowed the bot added to the attachment menu to write messages

##### Returns

[`WriteAccessAllowed`](WriteAccessAllowed.md)

#### Inherited from

[`Message`](Message.md).[`writeAccessAllowed`](Message.md#writeaccessallowed)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5088

Clears reactions from the message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`clearReactions`](NodeMixin.md#clearreactions)

***

### clone()

> **clone**(`options?`): `WriteAccessAllowedContext`

Defined in: contexts/index.d.ts:5273

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `WriteAccessAllowedContextOptions` |

#### Returns

`WriteAccessAllowedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

Defined in: contexts/index.d.ts:5074

Copies current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessageParams`](../../../../gramio/interfaces/CopyMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copy`](NodeMixin.md#copy)

***

### copyMessages()

> **copyMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5076

Copies messages from current chat and sends to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`CopyMessagesParams`](../../../../gramio/interfaces/CopyMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`copyMessages`](NodeMixin.md#copymessages)

***

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

Defined in: contexts/index.d.ts:5262

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | `Pick`<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"business_connection_id"` | `"message_thread_id"`> & `object` & `CreateActionControllerParams` |

#### Returns

`ChatActionController`<`Bot`>

#### Deprecated

Creates a controller that when `start()`ed executes `sendChatAction(action)` every `interval` milliseconds until `stop()`ped

#### Inherited from

[`ChatActionMixin`](ChatActionMixin.md).[`createActionController`](ChatActionMixin.md#createactioncontroller)

***

### delete()

> **delete**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5045

Deletes current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`DeleteMessageParams`](../../../../gramio/interfaces/DeleteMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`delete`](NodeMixin.md#delete)

***

### deleteMessages()

> **deleteMessages**(`ids`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5047

Deletes messages in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ids` | `number`\[] |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`deleteMessages`](NodeMixin.md#deletemessages)

***

### editCaption()

> **editCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5063

Edits current message caption. An alias for `editMessageCaption`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editCaption`](NodeMixin.md#editcaption)

***

### editChecklist()

> **editChecklist**(`checklist`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5064

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `checklist` | [`TelegramInputChecklist`](../../../../gramio/interfaces/TelegramInputChecklist.md) |
| `params?` | `Partial`<[`EditMessageChecklistParams`](../../../../gramio/interfaces/EditMessageChecklistParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editChecklist`](NodeMixin.md#editchecklist)

***

### editLiveLocation()

> **editLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5051

Edits current message live location. An alias for `editMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editLiveLocation`](NodeMixin.md#editlivelocation)

***

### editMedia()

> **editMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5068

Edits current message media. An alias for `editMessageMedia`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMedia`](NodeMixin.md#editmedia)

***

### editMessageCaption()

> **editMessageCaption**(`caption`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5061

Edits current message caption

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `caption` | `NonNullable`<`string` | { `toString`: `string`; }> |
| `params?` | `Partial`<[`EditMessageCaptionParams`](../../../../gramio/interfaces/EditMessageCaptionParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageCaption`](NodeMixin.md#editmessagecaption)

***

### editMessageLiveLocation()

> **editMessageLiveLocation**(`params`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5049

Edits current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`EditMessageLiveLocationParams`](../../../../gramio/interfaces/EditMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageLiveLocation`](NodeMixin.md#editmessagelivelocation)

***

### editMessageMedia()

> **editMessageMedia**(`media`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5066

Edits current message media

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `media` | [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md) |
| `params?` | `Partial`<[`EditMessageMediaParams`](../../../../gramio/interfaces/EditMessageMediaParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageMedia`](NodeMixin.md#editmessagemedia)

***

### editMessageReplyMarkup()

> **editMessageReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5070

Edits current message reply markup

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageReplyMarkup`](NodeMixin.md#editmessagereplymarkup)

***

### editMessageText()

> **editMessageText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5057

Edits current message text

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editMessageText`](NodeMixin.md#editmessagetext)

***

### editReplyMarkup()

> **editReplyMarkup**(`replyMarkup`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5072

Edits current message reply markup. An alias for `editMessageReplyMarkup`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `replyMarkup` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } |
| `params?` | `Partial`<[`EditMessageReplyMarkupParams`](../../../../gramio/interfaces/EditMessageReplyMarkupParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editReplyMarkup`](NodeMixin.md#editreplymarkup)

***

### editText()

> **editText**(`text`, `params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5059

Edits current message text. An alias for `editMessageText`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `Partial`<[`EditMessageTextParams`](../../../../gramio/interfaces/EditMessageTextParams.md)> |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`editText`](NodeMixin.md#edittext)

***

### forward()

> **forward**(`params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5078

Forwards current message \[into other chat if `chatId` is provided]

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessageParams`](../../../../gramio/interfaces/ForwardMessageParams.md), `"chat_id"` | `"message_id"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forward`](NodeMixin.md#forward)

***

### forwardMessages()

> **forwardMessages**(`chatId`, `ids`, `params?`): `Promise`<[`MessageId`](MessageId.md)\[]>

Defined in: contexts/index.d.ts:5080

Forwards messages from current chat to another

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chatId` | `string` | `number` |
| `ids` | `number`\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ForwardMessagesParams`](../../../../gramio/interfaces/ForwardMessagesParams.md), `"chat_id"` | `"message_ids"` | `"from_chat_id"`> |

#### Returns

`Promise`<[`MessageId`](MessageId.md)\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`forwardMessages`](NodeMixin.md#forwardmessages)

***

### getChatBoosts()

> **getChatBoosts**(`userId`): `Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

Defined in: contexts/index.d.ts:4938

Returns chat boosts by the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `number` |

#### Returns

`Promise`<[`TelegramUserChatBoosts`](../../../../gramio/interfaces/TelegramUserChatBoosts.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`getChatBoosts`](SendMixin.md#getchatboosts)

***

### hasFrom()

> **hasFrom**(): this is Require\<WriteAccessAllowedContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4742

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<WriteAccessAllowedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3029

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasMediaSpoiler`](Message.md#hasmediaspoiler)

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:2962

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<WriteAccessAllowedContext<Bot>, "senderChat">`

Defined in: contexts/index.d.ts:4746

Checks if the instance has `senderChat` property

#### Returns

`this is Require<WriteAccessAllowedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4735

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`UpdateName`](../type-aliases/UpdateName.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawTypes` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`SoftString`](../type-aliases/SoftString.md)<`T`>> |

#### Returns

`this is InstanceType<ContextsMapping<Bot>[T]> & Bot["__Derives"]["global"] & Bot["__Derives"][T] & (Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:2945

`true`, if the message is a channel post that was automatically forwarded to the connected discussion group

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isAutomaticForward`](Message.md#isautomaticforward)

***

### isChannel()

> **isChannel**(): `this is RequireValue<WriteAccessAllowedContext<Bot>, "chatType", Channel>`

Defined in: contexts/index.d.ts:4775

Is this chat a channel?

#### Returns

`this is RequireValue<WriteAccessAllowedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:2964

`true`, True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isFromOffline`](Message.md#isfromoffline)

***

### isGroup()

> **isGroup**(): `this is RequireValue<WriteAccessAllowedContext<Bot>, "chatType", Group>`

Defined in: contexts/index.d.ts:4771

Is this chat a group?

#### Returns

`this is RequireValue<WriteAccessAllowedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

Defined in: contexts/index.d.ts:2966

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`isPaidPost`](Message.md#ispaidpost)

***

### isPM()

> **isPM**(): `this is RequireValue<WriteAccessAllowedContext<Bot>, "chatType", Private>`

Defined in: contexts/index.d.ts:4769

Is this chat a private one?

#### Returns

`this is RequireValue<WriteAccessAllowedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3027

True, if the caption must be shown above the message media

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isShowCaptionAboveMedia`](Message.md#isshowcaptionabovemedia)

***

### isSupergroup()

> **isSupergroup**(): `this is RequireValue<WriteAccessAllowedContext<Bot>, "chatType", Supergroup>`

Defined in: contexts/index.d.ts:4773

Is this chat a supergroup?

#### Returns

`this is RequireValue<WriteAccessAllowedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:2943

`true`, if the message is sent to a forum topic

#### Returns

`boolean`

#### Inherited from

[`Message`](Message.md).[`isTopicMessage`](Message.md#istopicmessage)

***

### pinChatMessage()

> **pinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5195

Adds message to the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`PinChatMessageParams`](../../../../gramio/interfaces/PinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`pinChatMessage`](PinsMixin.md#pinchatmessage)

***

### quoteWithAnimation()

> **quoteWithAnimation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5008

Replies to current message with a quote and an animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAnimation`](NodeMixin.md#quotewithanimation)

***

### quoteWithAudio()

> **quoteWithAudio**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5000

Replies to current message with a quote and an audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"caption"` | `"title"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"duration"` | `"performer"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithAudio`](NodeMixin.md#quotewithaudio)

***

### quoteWithContact()

> **quoteWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5033

Replies to current message with a quote and a contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"phone_number"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"first_name"` | `"last_name"` | `"vcard"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithContact`](NodeMixin.md#quotewithcontact)

***

### quoteWithDice()

> **quoteWithDice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5041

Replies to current message with a quote and a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDice`](NodeMixin.md#quotewithdice)

***

### quoteWithDocument()

> **quoteWithDocument**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4996

Replies to current message with a quote and a document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"thumbnail"` | `"disable_content_type_detection"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithDocument`](NodeMixin.md#quotewithdocument)

***

### quoteWithInvoice()

> **quoteWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5029

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"title"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"description"` | `"provider_token"` | `"prices"` | `"max_tip_amount"` | `"suggested_tip_amounts"` | `"start_parameter"` | `"provider_data"` | `"photo_url"` | `"photo_size"` | `"photo_width"` | `"photo_height"` | `"need_name"` | `"need_phone_number"` | `"need_email"` | `"need_shipping_address"` | `"send_phone_number_to_provider"` | `"send_email_to_provider"` | `"is_flexible"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithInvoice`](NodeMixin.md#quotewithinvoice)

***

### quoteWithLocation()

> **quoteWithLocation**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5024

Replies to current message with a quote and a location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"horizontal_accuracy"` | `"live_period"` | `"heading"` | `"proximity_alert_radius"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithLocation`](NodeMixin.md#quotewithlocation)

***

### quoteWithMediaGroup()

> **quoteWithMediaGroup**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:5020

Replies to current message with a quote and a media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithMediaGroup`](NodeMixin.md#quotewithmediagroup)

***

### quoteWithPhoto()

> **quoteWithPhoto**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4992

Replies to current message with a quote and a photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPhoto`](NodeMixin.md#quotewithphoto)

***

### quoteWithPoll()

> **quoteWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5035

Replies to current message with a quote and a poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"question"` | `"options"` | `"type"` | `"explanation"` | `"business_connection_id"` | `"message_thread_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"reply_parameters"` | `"reply_markup"` | `"question_parse_mode"` | `"question_entities"` | `"is_anonymous"` | `"allows_multiple_answers"` | `"correct_option_id"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithPoll`](NodeMixin.md#quotewithpoll)

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5037

Replies to current message with a quote and a sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"emoji"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithSticker`](NodeMixin.md#quotewithsticker)

***

### quoteWithVenue()

> **quoteWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5031

Replies to current message with a quote and a venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"title"` | `"address"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"latitude"` | `"longitude"` | `"foursquare_id"` | `"foursquare_type"` | `"google_place_id"` | `"google_place_type"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVenue`](NodeMixin.md#quotewithvenue)

***

### quoteWithVideo()

> **quoteWithVideo**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5004

Replies to current message with a quote and a video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"show_caption_above_media"` | `"has_spoiler"` | `"thumbnail"` | `"duration"` | `"width"` | `"height"` | `"cover"` | `"start_timestamp"` | `"supports_streaming"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideo`](NodeMixin.md#quotewithvideo)

***

### quoteWithVideoNote()

> **quoteWithVideoNote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5012

Replies to current message with a quote and a video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"length"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"thumbnail"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVideoNote`](NodeMixin.md#quotewithvideonote)

***

### quoteWithVoice()

> **quoteWithVoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5016

Replies to current message with a quote and a voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"caption"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"` | `"caption_entities"` | `"duration"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`quoteWithVoice`](NodeMixin.md#quotewithvoice)

***

### react()

> **react**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5086

Reacts to a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | [`MaybeArray`](../type-aliases/MaybeArray.md)<[`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md)> |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`react`](NodeMixin.md#react)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4956

Replies to current message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`reply`](NodeMixin.md#reply)

***

### replyWithAnimation()

> **replyWithAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4966

Replies to current message with animation

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAnimation`](NodeMixin.md#replywithanimation)

***

### replyWithAudio()

> **replyWithAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4962

Replies to current message with audio

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithAudio`](NodeMixin.md#replywithaudio)

***

### replyWithContact()

> **replyWithContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4980

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithContact`](NodeMixin.md#replywithcontact)

***

### replyWithDice()

> **replyWithDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4986

Replies to current message with a dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `WithPartialReplyParameters`<`Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDice`](NodeMixin.md#replywithdice)

***

### replyWithDocument()

> **replyWithDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4960

Replies to current message with document

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithDocument`](NodeMixin.md#replywithdocument)

***

### replyWithInvoice()

> **replyWithInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4976

Replies to current message with invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithInvoice`](NodeMixin.md#replywithinvoice)

***

### replyWithLocation()

> **replyWithLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4974

Replies to current message with location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithLocation`](NodeMixin.md#replywithlocation)

***

### replyWithMediaGroup()

> **replyWithMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4972

Replies to current message with media group

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithMediaGroup`](NodeMixin.md#replywithmediagroup)

***

### replyWithPhoto()

> **replyWithPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4958

Replies to current message with photo

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPhoto`](NodeMixin.md#replywithphoto)

***

### replyWithPoll()

> **replyWithPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4982

Replies to current message with poll

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithPoll`](NodeMixin.md#replywithpoll)

***

### replyWithQuote()

> **replyWithQuote**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4988

Replies to current message with a quote

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `object` & `Pick`<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"entities"` | `"business_connection_id"` | `"message_thread_id"` | `"direct_messages_topic_id"` | `"parse_mode"` | `"link_preview_options"` | `"disable_notification"` | `"protect_content"` | `"allow_paid_broadcast"` | `"message_effect_id"` | `"suggested_post_parameters"` | `"reply_parameters"` | `"reply_markup"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithQuote`](NodeMixin.md#replywithquote)

***

### replyWithSticker()

> **replyWithSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4984

Replies to current message with sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithSticker`](NodeMixin.md#replywithsticker)

***

### replyWithVenue()

> **replyWithVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4978

Replies to current message with venue

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVenue`](NodeMixin.md#replywithvenue)

***

### replyWithVideo()

> **replyWithVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4964

Replies to current message with video

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideo`](NodeMixin.md#replywithvideo)

***

### replyWithVideoNote()

> **replyWithVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4968

Replies to current message with video note

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVideoNote`](NodeMixin.md#replywithvideonote)

***

### replyWithVoice()

> **replyWithVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4970

Replies to current message with voice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | `WithPartialReplyParameters`<[`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`>> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`replyWithVoice`](NodeMixin.md#replywithvoice)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4868

Sends message to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` | { `toString`: `string`; } |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`send`](SendMixin.md#send)

***

### sendAnimation()

> **sendAnimation**(`animation`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4878

Sends animation to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `animation` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md), `"animation"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAnimation`](SendMixin.md#sendanimation)

***

### sendAudio()

> **sendAudio**(`audio`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4874

Sends audio to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `audio` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md), `"audio"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendAudio`](SendMixin.md#sendaudio)

***

### sendChatAction()

> **sendChatAction**(`action`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4902

Sends chat action to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | [`SendChatActionAction`](../../../../gramio/type-aliases/SendChatActionAction.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendChatActionParams`](../../../../gramio/interfaces/SendChatActionParams.md), `"chat_id"` | `"action"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChatAction`](SendMixin.md#sendchataction)

***

### sendChecklist()

> **sendChecklist**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4894

Sends checklist to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendChecklistParams`](../../../../gramio/interfaces/SendChecklistParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendChecklist`](SendMixin.md#sendchecklist)

***

### sendContact()

> **sendContact**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4890

Sends contact to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendContactParams`](../../../../gramio/interfaces/SendContactParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendContact`](SendMixin.md#sendcontact)

***

### sendDice()

> **sendDice**(`emoji`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4904

Sends dice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `emoji` | [`SendDiceEmoji`](../../../../gramio/type-aliases/SendDiceEmoji.md) |
| `params?` | `Partial`<[`SendDiceParams`](../../../../gramio/interfaces/SendDiceParams.md)> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDice`](SendMixin.md#senddice)

***

### sendDocument()

> **sendDocument**(`document`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4872

Sends document to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `document` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md), `"document"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendDocument`](SendMixin.md#senddocument)

***

### sendInvoice()

> **sendInvoice**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4886

Sends invoice to current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendInvoice`](SendMixin.md#sendinvoice)

***

### sendLocation()

> **sendLocation**(`latitude`, `longitude`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4884

Sends location to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `latitude` | `number` |
| `longitude` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendLocationParams`](../../../../gramio/interfaces/SendLocationParams.md), `"chat_id"` | `"latitude"` | `"longitude"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendLocation`](SendMixin.md#sendlocation)

***

### sendMedia()

> **sendMedia**<`T`>(`query`): `ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

Defined in: contexts/index.d.ts:4921

Automatically uses correct media method to send media

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `query` | `object` & [`tSendMethods`](../type-aliases/tSendMethods.md) |

#### Returns

`ReturnType`<`T` *extends* `"animation"` ? (`animation`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"audio"` ? (`audio`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"document"` ? (`document`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"photo"` ? (`photo`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"sticker"` ? (`sticker`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video_note"` ? (`videoNote`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>> : `T` *extends* `"video"` ? (`video`, `params?`) => `Promise`<[`MessageContext`](MessageContext.md)<...>> : `T` *extends* `"voice"` ? (`voice`, `params?`) => `Promise`<...> : () => `never`>

#### Example

```js
context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMedia`](SendMixin.md#sendmedia)

***

### sendMediaGroup()

> **sendMediaGroup**(`mediaGroup`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4908

Sends media group to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `mediaGroup` | ([`TelegramInputMediaAudio`](../../../../gramio/interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](../../../../gramio/interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](../../../../gramio/interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../../../../gramio/interfaces/TelegramInputMediaVideo.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendMediaGroupParams`](../../../../gramio/interfaces/SendMediaGroupParams.md), `"chat_id"` | `"media"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMediaGroup`](SendMixin.md#sendmediagroup)

***

### sendMessageDraft()

> **sendMessageDraft**(`params`): `Promise`<`true`>

Defined in: contexts/index.d.ts:4900

Sends a message draft to the current private chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendMessageDraft`](SendMixin.md#sendmessagedraft)

***

### sendPaidMedia()

> **sendPaidMedia**(`paidMedia`, `starCount`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4906

Sends paid media to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `paidMedia` | [`TelegramInputPaidMedia`](../../../../gramio/type-aliases/TelegramInputPaidMedia.md)\[] |
| `starCount` | `number` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPaidMediaParams`](../../../../gramio/interfaces/SendPaidMediaParams.md), `"chat_id"` | `"media"` | `"star_count"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPaidMedia`](SendMixin.md#sendpaidmedia)

***

### sendPhoto()

> **sendPhoto**(`photo`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4870

Sends photo to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `photo` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md), `"photo"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPhoto`](SendMixin.md#sendphoto)

***

### sendPoll()

> **sendPoll**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4892

Sends poll to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendPollParams`](../../../../gramio/interfaces/SendPollParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendPoll`](SendMixin.md#sendpoll)

***

### sendSticker()

> **sendSticker**(`sticker`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4896

Sends sticker

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sticker` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md), `"sticker"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendSticker`](SendMixin.md#sendsticker)

***

### sendVenue()

> **sendVenue**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4888

Sends venue to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`Optional`](../type-aliases/Optional.md)<[`SendVenueParams`](../../../../gramio/interfaces/SendVenueParams.md), `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVenue`](SendMixin.md#sendvenue)

***

### sendVideo()

> **sendVideo**(`video`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4876

Sends video to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `video` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md), `"video"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideo`](SendMixin.md#sendvideo)

***

### sendVideoNote()

> **sendVideoNote**(`videoNote`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4880

Sends video note to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `videoNote` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md), `"video_note"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVideoNote`](SendMixin.md#sendvideonote)

***

### sendVoice()

> **sendVoice**(`voice`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:4882

Sends voice to current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `voice` | `string` | `Blob` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md), `"voice"` | `"chat_id"`> |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`SendMixin`](SendMixin.md).[`sendVoice`](SendMixin.md#sendvoice)

***

### setReaction()

> **setReaction**(`reaction`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5082

Sets a reaction on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `reaction` | [`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md) |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReaction`](NodeMixin.md#setreaction)

***

### setReactions()

> **setReactions**(`rawReactions`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5084

Sets multiple amount of reactions on a message

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawReactions` | ([`TelegramReactionTypeEmojiEmoji`](../../../../gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md) | [`TelegramReactionType`](../../../../gramio/type-aliases/TelegramReactionType.md))\[] |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetMessageReactionParams`](../../../../gramio/interfaces/SetMessageReactionParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`setReactions`](NodeMixin.md#setreactions)

***

### stopLiveLocation()

> **stopLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5055

Stops current message live location. An alias for `stopMessageLiveLocation`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopLiveLocation`](NodeMixin.md#stoplivelocation)

***

### stopMessageLiveLocation()

> **stopMessageLiveLocation**(`params?`): `Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5053

Stops current message live location

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`StopMessageLiveLocationParams`](../../../../gramio/interfaces/StopMessageLiveLocationParams.md) |

#### Returns

`Promise`<`true` | [`MessageContext`](MessageContext.md)<`Bot`>>

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`stopMessageLiveLocation`](NodeMixin.md#stopmessagelivelocation)

***

### stopPoll()

> **stopPoll**(`messageId`, `params?`): `Promise`<[`Poll`](Poll.md)>

Defined in: contexts/index.d.ts:4898

Stops poll in current chat

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `messageId` | `number` |
| `params?` | `Partial`<[`StopPollParams`](../../../../gramio/interfaces/StopPollParams.md)> |

#### Returns

`Promise`<[`Poll`](Poll.md)>

#### Inherited from

[`SendMixin`](SendMixin.md).[`stopPoll`](SendMixin.md#stoppoll)

***

### streamMessage()

> **streamMessage**(`stream`, `options?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

Defined in: contexts/index.d.ts:4936

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities).
Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment.
Returns an array of sent MessageContext objects.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stream` | `Iterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> | `AsyncIterable`<[`MessageDraftPiece`](../type-aliases/MessageDraftPiece.md), `any`, `any`> |
| `options?` | [`StreamMessageOptions`](../interfaces/StreamMessageOptions.md) |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>\[]>

#### Example

```ts
// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);
```

#### Inherited from

[`SendMixin`](SendMixin.md).[`streamMessage`](SendMixin.md#streammessage)

***

### unpinAllChatMessages()

> **unpinAllChatMessages**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5199

Clears the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinAllChatMessagesParams`](../../../../gramio/interfaces/UnpinAllChatMessagesParams.md), `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinAllChatMessages`](PinsMixin.md#unpinallchatmessages)

***

### unpinChatMessage()

> **unpinChatMessage**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5197

Removes message from the list of pinned messages

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`UnpinChatMessageParams`](../../../../gramio/interfaces/UnpinChatMessageParams.md), `"chat_id"` | `"message_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`PinsMixin`](PinsMixin.md).[`unpinChatMessage`](PinsMixin.md#unpinchatmessage)

---

---
url: 'https://gramio.dev/triggers/command.md'
---

# Command

The command method in GramIO allows you to create handlers for specific [bot commands](https://core.telegram.org/bots/features#commands). Commands are specific words or phrases that usually begin with a `/` and are used to trigger actions or responses from the bot.

Telegram apps will:

* **Highlight** commands in messages. When the user taps a highlighted command, that command is immediately sent again.
* Suggest a **list of supported commands** with descriptions when the user enters a `/` (for this to work, you need to have provided a list of commands to [@BotFather](https://t.me/botfather) or via the [appropriate API method](https://core.telegram.org/bots/api#setmycommands)). Selecting a command from the list immediately sends it.
* Show a [menu button](https://core.telegram.org/bots/features#menu-button) containing all or some of a bot’s commands (which you set via [@BotFather](https://t.me/botfather)).

Commands must always start with the `/` symbol and contain **up to 32 characters**. They can use **Latin letters**, **numbers** and **underscores**, though simple lowercase text is recommended for a cleaner look.

> \[!IMPORTANT]
> The command can also be triggered using the full command with the bot's username, such as `/start@name_bot`.

![](https://core.telegram.org/file/464001775/10227/HCr0XgSUHrg.119089/c17ff5d34fe528361e)

## Basic Usage

### Registering a Simple Command

You can use the `command` method to make your bot respond to specific commands. Here’s a basic example:

```ts
bot.command("start", (context) => {
    return context.send(`Hi!`);
});
```

> \[!IMPORTANT]
> You don't need to include a `/` when specifying the command name. If you turn it on, you will get an `error`.

In this example, the bot listens for the `/start` command. When the command is received, the bot responds with a simple "Hi!" message.

### Example with Command Arguments

Here’s an example that demonstrates how to use arguments with commands:

```ts
bot.command("start", async (context) => {
    return context.send(
        `You entered the command /start with arguments: ${context.args}`
    );
});
```

In this scenario, if a user sends `/start arg1 arg2`, the bot will respond with `You entered the command /start with arguments: arg1 arg2`.

### How `command` Works

1. **Command Recognition:** The bot checks the message for a command (e.g., `/start`). Commands are typically indicated by the [`bot_command` entity](https://core.telegram.org/bots/api#messageentity) in Telegram messages.

2. **Command Matching:** The bot compares the detected command against the command you specified in the `command` method.

3. **Handling Commands with Bot Username:** The command is also recognized if it includes the bot's username, such as `/start@name_bot`.

4. **Command Arguments:** If there are additional arguments following the command (e.g., `/start arg1 arg2`), these are passed to `context.args` for further processing.

---

---
url: 'https://gramio.dev/plugins/how-to-write.md'
---

# How to Write a Plugin

It happens that you are missing something... And plugins can help you with this!

# Example

```ts twoslash [index.ts]
import { Plugin, Bot } from "gramio";

export class PluginError extends Error {
    wow: "type" | "safe" = "type";
}

const plugin = new Plugin("gramio-example")
    .error("PLUGIN", PluginError)
    .derive(() => {
        return {
            some: ["derived", "props"] as const,
        };
    });

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(plugin)
    .onError(({ context, kind, error }) => {
        if (context.is("message") && kind === "PLUGIN") {
            console.log(error.wow);
            //                 ^?
        }
    })
    .use((context) => {
        console.log(context.some);
        //                  ^^^^
    });
```

## Scaffolding the plugin

This command will help you create a plugin with GramIO the easiest way.

::: pm-create gramio-plugin ./plugin
:::

## Supported Environment

#### Linters

* [Biome](https://biomejs.dev/)
* [ESLint](https://eslint.org/) (with some plugins)

#### Storage

* [Storage](https://gramio.dev/storages/)

#### Others

* [Husky](https://typicode.github.io/husky/) (Git hooks)

---

---
url: 'https://gramio.dev/guides/for-beginners/2.md'
---

# First Steps

#### What we'll do

* Create a bot account
* Install and configure the project
* Launch a bot that responds to the `/start` command
* Learn to work with environment variables and `--watch` mode

### Creating a Telegram Bot Account

First, create your bot and get a `token`. You can do this using the [@BotFather](https://t.me/BotFather) bot.

Send him the `/newbot` command and follow the instructions until you receive a token like `110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw`.

### Installation

To begin, we need to create a project and install `GramIO` using `npm`. Create a folder and run `npm init` in it to create a package.json for our project. Also specify `"type": "module"` so that the config looks something like this:

```json
{
    "name": "bot-test",
    "type": "module",
    "version": "1.0.0",
    "main": "index.js",
    "scripts": {
        "test": "echo \"Error: no test specified\" && exit 1"
    },
    "author": "",
    "license": "ISC",
    "description": ""
}
```

Next, we'll install the dependency we need - GramIO.

```bash
npm install gramio # or npm i gramio
```

### Your First Bot

Let's write the logic for our first bot. Create an `index.js` file and write:

```js
import { Bot } from "gramio";

const bot = new Bot("12345678:AaBbCcDdEeFfGgHh").command("start", (context) =>
    context.send("You sent /start")
);

bot.start();
```

where `12345678:AaBbCcDdEeFfGgHh` is your bot token.

This code can be broken down into parts:

* `import { Bot } from "gramio";` - this is an [import](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Statements/import) of the main class of our library.
* `const bot = new Bot("12345678:AaBbCcDdEeFfGgHh")` - we create a `bot` variable and initialize the class by passing it our bot token.
* `.command("start", (context) => {...});` - We register our `/start` command handler that will be called when a user sends this command.
* `context.send("You sent /start")` - using this method we send the specified message to the same chat.
* `bot.start();` - with this we start listening for events using Long-Polling (not important for now).

Let's run this code with `node index.js` and check the bot's operation.

### What's `.send`?

This is a method of the `Message` context that allows you to send a message to the same chat where the original message came from. Thanks to this, we don't need to fully specify which chat we need to send a message to, but if needed, we can also use the regular methods from the [API](https://core.telegram.org/bots/api).

You can send a request to the API outside of event handlers:

```js
import { Bot } from "gramio";

const bot = new Bot("12345678:AaBbCcDdEeFfGgHh");

bot.api.sendMessage({
    chat_id: "required chat id",
    text: "You sent /start",
});
```

But in handlers, you'll need to access the `context.bot` variable which is our initialized bot class:

```js
import { Bot } from "gramio";

const bot = new Bot("12345678:AaBbCcDdEeFfGgHh").command("start", (context) =>
    context.bot.api.sendMessage({
        chat_id: "required chat id",
        text: "You sent /start",
    })
);

bot.start();
```

### Bot Configuration

It's worth remembering that storing the token directly in your code is bad practice. It's recommended to store secrets in environment variables, so let's create a `.env` file in our project and move the token there:

```dotenv
BOT_TOKEN=12345678:AaBbCcDdEeFfGgHh
```

Declaring environment variables in this file is extremely simple - it's just a `key=value` pair.

Great, the file is created, but how do we access these environment variables? For this, there's the `process.env` object where these variables will be available in our program. It's worth remembering that the `.env` file exists for convenience, and not all programs read it by default. For example, in Node.js we need to specify it using the `--env-file` argument.

Let's modify our code to use environment variables:

```js
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN).command("start", (context) =>
    context.send("You sent /start")
);

bot.start();
```

And let's run it by specifying our `.env` file ([docs](https://nodejs.org/en/learn/command-line/how-to-read-environment-variables-from-nodejs)):

```bash
node --env-file=.env index.js
```

Let's also add `--watch` mode, which will restart our script whenever changes are made to the file:

```bash
node --watch --env-file=.env index.js
```

For convenience, let's put this command in our `package.json`:

Add a `scripts` object and `dev` with the contents of our command. The result should look something like this:

```json
{
    "name": "bot-test",
    "type": "module",
    "version": "1.0.0",
    "main": "index.js",
    "scripts": {
        "dev": "node --watch --env-file=.env index.js"
    },
    "author": "",
    "license": "ISC",
    "description": "",
    "dependencies": {
        "gramio": "^0.0.40"
    }
}
```

Now we can run it like this: `npm run dev`

---

---
url: 'https://gramio.dev/ecosystem/crypto-pay-api.md'
---

# Crypto Pay API

[![npm](https://img.shields.io/npm/v/@gramio/crypto-pay-api?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/crypto-pay-api)
[![npm downloads](https://img.shields.io/npm/dw/@gramio/crypto-pay-api?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/crypto-pay-api)
[![JSR](https://jsr.io/badges/@gramio/crypto-pay-api)](https://jsr.io/@gramio/crypto-pay-api)
[![JSR Score](https://jsr.io/badges/@gramio/crypto-pay-api/score)](https://jsr.io/@gramio/crypto-pay-api)

Fully-typed TypeScript client for the [Crypto Pay (Crypto Bot) API](https://help.crypt.bot/crypto-pay-api). Create and manage cryptocurrency invoices, transfers, and checks with webhook support for **8 web frameworks**.

Works on **Node.js**, **Bun**, and **Deno**.

## Installation

::: pm-add @gramio/crypto-pay-api
:::

## Quick start

```ts
import { CryptoPayAPI, webhookHandler } from "@gramio/crypto-pay-api";

const api = new CryptoPayAPI("your-api-key", "testnet");

// Listen for paid invoices
api.on("invoice_paid", ({ payload: invoice }) => {
    console.log(invoice.amount, invoice.payload);
});

// Create an invoice
const invoice = await api.createInvoice({
    amount: "100",
    asset: "USDT",
});
console.log(invoice.bot_invoice_url);

// Start webhook server (Bun example)
Bun.serve({
    routes: {
        "/webhook": {
            POST: webhookHandler(api, "Bun.serve"),
        },
    },
});
```

## Constructor

```ts
import { CryptoPayAPI } from "@gramio/crypto-pay-api";

// Mainnet (default)
const api = new CryptoPayAPI("your-api-key");

// Testnet (get token from @CryptoTestnetBot)
const api = new CryptoPayAPI("your-api-key", "testnet");
```

## Methods

### `getMe`

Test authentication and get app info.

```ts
const me = await api.getMe();
// { app_id: number, name: string, bot_username: string }
```

### `createInvoice`

Create a payment request.

```ts
const invoice = await api.createInvoice({
    amount: "100",
    asset: "USDT",
    description: "Premium subscription",
    payload: "user_123_premium",
    paid_btn_name: "openBot",
    paid_btn_url: "https://t.me/YourBot",
    // Optional:
    // currency_type: "fiat",
    // fiat: "USD",
    // accepted_assets: ["USDT", "TON"],
    // allow_comments: true,
    // allow_anonymous: true,
    // expires_in: 3600,
});

console.log(invoice.bot_invoice_url); // send to user
```

### `createCheck`

Create a crypto check (voucher) another user can redeem.

```ts
const check = await api.createCheck({
    asset: "TON",
    amount: "5",
});
console.log(check.bot_check_url); // share with recipient
```

### `transfer`

Transfer funds to a Telegram user.

```ts
const transfer = await api.transfer({
    user_id: "123456789",
    asset: "USDT",
    amount: "10",
    spend_id: "unique_transfer_001",
    comment: "Contest prize",
});
```

### `getInvoices`

Retrieve invoices with optional filtering.

```ts
const invoices = await api.getInvoices({
    status: "paid",
    offset: 0,
    count: 10,
});
```

### `getBalance`

Get current app wallet balances.

```ts
const balances = await api.getBalance();
// [{ currency_code: "USDT", available: "100.50", onhold: "0" }, ...]
```

### `getExchangeRates`

Get current exchange rates.

```ts
const rates = await api.getExchangeRates();
```

### `getStats`

Get aggregated app statistics.

```ts
const stats = await api.getStats({
    start_at: "2025-01-01T00:00:00Z",
});
// { volume, conversion, unique_users_count, ... }
```

### `deleteInvoice` / `deleteCheck`

```ts
await api.deleteInvoice({ invoice_ids: [123, 456] });
await api.deleteCheck({ check_ids: [789] });
```

## Webhooks

Register event listeners and use `webhookHandler` with your web framework.

```ts
api.on("invoice_paid", ({ payload: invoice }) => {
    console.log(`Invoice ${invoice.invoice_id} paid!`);
    console.log(`Amount: ${invoice.paid_amount} ${invoice.paid_asset}`);
});
```

### Supported frameworks

| Framework | Adapter key |
|---|---|
| Bun.serve | `"Bun.serve"` |
| Elysia | `"elysia"` |
| Fastify | `"fastify"` |
| Hono | `"hono"` |
| Express | `"express"` |
| Koa | `"koa"` |
| Node.js HTTP | `"http"` |
| Deno std/http | `"std/http"` |

### Examples

::: code-group

```ts [Bun.serve]
Bun.serve({
    routes: {
        "/webhook": {
            POST: webhookHandler(api, "Bun.serve"),
        },
    },
});
```

```ts [Express]
import express from "express";

const app = express();
app.use(express.json());
app.post("/webhook", webhookHandler(api, "express"));
app.listen(3000);
```

```ts [Hono]
import { Hono } from "hono";

const app = new Hono();
app.post("/webhook", webhookHandler(api, "hono"));
```

```ts [Fastify]
import Fastify from "fastify";

const fastify = Fastify();
fastify.post("/webhook", webhookHandler(api, "fastify"));
fastify.listen({ port: 3000 });
```

```ts [Node.js HTTP]
import http from "node:http";

const handler = webhookHandler(api, "http");

http.createServer((req, res) => {
    if (req.url === "/webhook" && req.method === "POST") {
        handler(req, res);
    }
}).listen(3000);
```

```ts [Deno]
Deno.serve((req) => {
    if (new URL(req.url).pathname === "/webhook") {
        return webhookHandler(api, "std/http")(req);
    }
    return new Response("Not found", { status: 404 });
});
```

:::

## Supported assets

`USDT` | `TON` | `BTC` | `ETH` | `LTC` | `BNB` | `TRX` | `USDC` | `JET`

---

---
url: 'https://gramio.dev/recipes/docker.md'
---
# Docker

---

---
url: 'https://gramio.dev/files/download.md'
---

# Download

The standard file download path looks like this:

* Call `getFile` with `file_id`
* Extract `file_path` from response
* Construct a link of the following type `https://api.telegram.org/file/bot<token>/<file_path>`
* Send request and download the requested media
* ? Maybe save file in FS ?

but in our case it looks more convenient and simpler.

## Via context methods

```ts
bot.on("message", async (context) => {
    if (!context.document) return;
    // download to ./file-name
    await context.download(context.document.fileName || "file-name");
    // get ArrayBuffer
    const buffer = await context.download();

    return context.send("Thank you!");
});
```

> \[!IMPORTANT]
>
> **One message** contain only **one attachment**. Therefore, to download an attachment, you can simply use the `context.download` method
> But you can solve this using the [media-group](/plugins/official/media-group) plugin.

## Via bot instance method

```ts
const chat = await bot.api.getChat({ chat_id: "@not_found" });

if (!chat.photo?.big_file_id) return;

// download to ./not_found_chat_photo.png
await bot.downloadFile(chat.photo.big_file_id, "not_found_chat_photo.png");
// get ArrayBuffer
const buffer = await bot.downloadFile(chat.photo.big_file_id);
```

---

---
url: 'https://gramio.dev/api/contexts/enumerations/ChatType.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ChatType

# Enumeration: ChatType

Defined in: contexts/index.d.ts:244

Enum of ChatType property

## Enumeration Members

| Enumeration Member | Value | Defined in |
| ------ | ------ | ------ |
|  `Channel` | `"channel"` | contexts/index.d.ts:248 |
|  `Group` | `"group"` | contexts/index.d.ts:246 |
|  `Private` | `"private"` | contexts/index.d.ts:245 |
|  `Supergroup` | `"supergroup"` | contexts/index.d.ts:247 |

---

---
url: 'https://gramio.dev/api/contexts/enumerations/EntityType.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / EntityType

# Enumeration: EntityType

Defined in: contexts/index.d.ts:292

Enum of EntityType property

## Enumeration Members

| Enumeration Member | Value | Defined in |
| ------ | ------ | ------ |
|  `Bold` | `"bold"` | contexts/index.d.ts:300 |
|  `BotCommand` | `"bot_command"` | contexts/index.d.ts:296 |
|  `Cashtag` | `"cashtag"` | contexts/index.d.ts:295 |
|  `Code` | `"code"` | contexts/index.d.ts:304 |
|  `Email` | `"email"` | contexts/index.d.ts:298 |
|  `Hashtag` | `"hashtag"` | contexts/index.d.ts:294 |
|  `Italic` | `"italic"` | contexts/index.d.ts:301 |
|  `Mention` | `"mention"` | contexts/index.d.ts:293 |
|  `PhoneNumber` | `"phone_number"` | contexts/index.d.ts:299 |
|  `Pre` | `"pre"` | contexts/index.d.ts:305 |
|  `Strikethrough` | `"strikethrough"` | contexts/index.d.ts:303 |
|  `TextLink` | `"text_link"` | contexts/index.d.ts:306 |
|  `TextMention` | `"text_mention"` | contexts/index.d.ts:307 |
|  `Underline` | `"underline"` | contexts/index.d.ts:302 |
|  `Url` | `"url"` | contexts/index.d.ts:297 |

---

---
url: 'https://gramio.dev/api/contexts/enumerations/PollType.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / PollType

# Enumeration: PollType

Defined in: contexts/index.d.ts:251

Enum of PollType property

## Enumeration Members

| Enumeration Member | Value | Defined in |
| ------ | ------ | ------ |
|  `Quiz` | `"quiz"` | contexts/index.d.ts:253 |
|  `Regular` | `"regular"` | contexts/index.d.ts:252 |

---

---
url: 'https://gramio.dev/guides/filters.md'
---

# Filters

:::warning UNRELEASED
The filters system is currently on the `main` branch and has not been included in a tagged release yet. The API may change before the stable release.
:::

GramIO's filter system lets you apply type-safe predicates to context — either as the third argument to `bot.on(event, filter, handler)` or as the only argument in a **filter-only** `.on(filter, handler)` call that auto-discovers compatible events.

## Filter-Only `.on()` — No Event Name Required

In the standard `.on(event, handler)`, you choose the event explicitly. With the filter-only overload you skip the event name entirely — GramIO infers which events are compatible from the shape of your predicate:

```ts
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN!);

// Boolean filter — runs on any update where ctx has `text`
bot.on(
    (ctx) => "text" in ctx && ctx.text?.startsWith("!"),
    (ctx) => {
        // ctx is narrowed to the union of all events that have a `text` field
        ctx.send("Command received!");
    },
);

// Type-narrowing predicate — narrows the handler's context type
bot.on(
    (ctx): ctx is { text: string } => typeof (ctx as any).text === "string",
    (ctx) => {
        ctx.text; // string — not string | undefined
    },
);
```

## Inline Filter on a Named Event

You can also pass a filter as the second argument to a named `.on()`:

```ts
bot.on(
    "message",
    (ctx) => ctx.text?.startsWith("/"),
    (ctx) => {
        // only messages starting with "/"
    },
);

// Type-narrowing inline filter
bot.on(
    "message",
    (ctx): ctx is typeof ctx & { text: string } => typeof ctx.text === "string",
    (ctx) => {
        ctx.text; // string
    },
);
```

## Standalone Predicate Functions

Import from `gramio` and pass as filters to `.on()` or `.guard()`:

```ts
import { filters } from "gramio";
```

### Message Content Filters

| Filter                    | Narrows to / Guards for                |
| ------------------------- | -------------------------------------- |
| `filters.reply`           | Message has `reply_to_message`         |
| `filters.entities`        | Message has `entities`                 |
| `filters.captionEntities` | Message has `caption_entities`         |
| `filters.quote`           | Message has a quoted reply (`quote`)   |
| `filters.viaBot`          | Message was sent via a bot (`via_bot`) |
| `filters.linkPreview`     | Message has `link_preview_options`     |
| `filters.startPayload`    | `/start` with a deep-link payload      |
| `filters.authorSignature` | Message has `author_signature`         |
| `filters.mediaGroup`      | Message belongs to a media group       |
| `filters.venue`           | Message is a venue                     |

```ts
bot.on("message", filters.reply, (ctx) => {
    ctx.replyMessage; // guaranteed present
});

bot.on("message", filters.startPayload, (ctx) => {
    // message is a /start with payload
});
```

### Sender & Chat Filters

| Filter                 | Description                             |
| ---------------------- | --------------------------------------- |
| `filters.hasFrom`      | Update has a `from` field (user sender) |
| `filters.isBot`        | `from.is_bot === true`                  |
| `filters.isPremium`    | `from.is_premium === true`              |
| `filters.isForum`      | Chat has `is_forum === true`            |
| `filters.service`      | Message is a service message            |
| `filters.topicMessage` | Message is in a forum topic             |
| `filters.mediaSpoiler` | Media has spoiler effect                |
| `filters.giveaway`     | Message contains a giveaway             |
| `filters.game`         | Message contains a game                 |
| `filters.story`        | Message is a story                      |
| `filters.effectId`     | Message has a message effect            |

### `filters.forwardOrigin(type?)` — Forward Origin Narrowing

Without an argument, matches any forwarded message. With a type argument, narrows the `forwardOrigin` type:

```ts
// Any forwarded message
bot.on("message", filters.forwardOrigin(), (ctx) => {
    ctx.forwardOrigin; // MessageOrigin (union of all origin types)
});

// Narrowed to a specific origin type
bot.on("message", filters.forwardOrigin("user"), (ctx) => {
    ctx.forwardOrigin; // MessageOriginUser
    ctx.forwardOrigin.sender_user; // TelegramUser
});

bot.on("message", filters.forwardOrigin("channel"), (ctx) => {
    ctx.forwardOrigin; // MessageOriginChannel
    ctx.forwardOrigin.chat; // TelegramChat
    ctx.forwardOrigin.message_id; // number
});
```

Available types: `"user"` | `"hidden_user"` | `"chat"` | `"channel"`

### `filters.senderChat(type?)` — Sender Chat Narrowing

```ts
// Any message sent on behalf of a chat (anonymous admin, channel)
bot.on("message", filters.senderChat(), (ctx) => {
    ctx.senderChat; // TelegramChat
});

// Narrowed to a specific chat type
bot.on("message", filters.senderChat("channel"), (ctx) => {
    ctx.senderChat; // TelegramChat & { type: "channel" }
});
```

## Composing Filters

Filters are plain functions — compose them with boolean logic:

```ts
const isPremiumAdmin = (ctx: any) =>
    filters.isPremium(ctx) &&
    filters.hasFrom(ctx) &&
    ctx.from.status === "administrator";

bot.on("message", isPremiumAdmin, handler);
```

## Type-Narrowing `guard()`

`guard()` with a type predicate narrows `TOut` for all **downstream** middleware in the chain:

```ts
const bot = new Bot(process.env.BOT_TOKEN!);

bot.guard(
    (ctx): ctx is typeof ctx & { text: string } => typeof ctx.text === "string",
).on("message", (ctx) => {
    ctx.text; // string — narrowed for all handlers after the guard
});
```

Without a type predicate (boolean guard), it acts as a gate that blocks the chain on `false` but doesn't narrow types.

## See Also

* [Middleware guide](/extend/middleware) — how middleware chains work
* [`.on()` reference](/bot-class#on) — full method signature
* [`guard()` reference](/bot-class#guard) — gate vs side-effect modes

---

---
url: 'https://gramio.dev/keyboards/force-reply-keyboard.md'
---

# Force Reply Keyboard

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](https://core.telegram.org/bots/features#privacy-mode).

See also [API Reference](https://jsr.io/@gramio/keyboards/doc/~/ForceReplyKeyboard).

## Import

### With GramIO

```ts twoslash
import { ForceReplyKeyboard } from "gramio";
```

### Without GramIO

```ts twoslash
import { ForceReplyKeyboard } from "@gramio/keyboards";
```

## Options ([Documentation](https://core.telegram.org/bots/api/#forcereply))

These parameters are responsible for the settings of the force reply keyboard

### selective

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](https://core.telegram.org/bots/api/#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.

```ts twoslash
import { ForceReplyKeyboard } from "@gramio/keyboards";
// ---cut---
new ForceReplyKeyboard().selective(); // to enable
new ForceReplyKeyboard().selective(false); // to disable
```

### placeholder

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

```ts twoslash
import { ForceReplyKeyboard } from "@gramio/keyboards";
// ---cut---
new ForceReplyKeyboard().placeholder("some text"); // to enable
new ForceReplyKeyboard().placeholder(); // to disable
```

---

---
url: 'https://gramio.dev/formatting.md'
---

# Format messages

[`@gramio/format`](https://github.com/gramiojs/format) is built-in GramIO package. You can also use it outside of this framework because it is framework-agnostic.

See also [API Reference](https://jsr.io/@gramio/format/doc).

> \[!IMPORTANT]
> **Do not use `parse_mode` with GramIO.** The `format` template literal and entity helpers produce structured `MessageEntity` objects, not escaped HTML/Markdown strings. Setting `parse_mode: "HTML"` or `parse_mode: "MarkdownV2"` alongside `@gramio/format` output will break your messages. GramIO handles entity injection automatically — no `parse_mode` needed.

## Format

Template literal that helps construct message entities for text formatting.

Use if you want to strip all of the indentation from the beginning of each line. (like [common-tags#stripindents](https://www.npmjs.com/package/common-tags#stripindents) or [dedent](https://www.npmjs.com/package/dedent))

> \[!IMPORTANT]
> For formatting with **arrays** always use the [`join`](#join) helper — never native `.join()`.

```ts twoslash
import { format, bold, link, italic, Bot } from "gramio";

const bot = new Bot("");
// ---cut---
format`some text`;
// or
format`${bold`Hmm...`} ${link(
    "GramIO",
    "https://github.com/gramiojs/gramio",
)}?`;
```

Let's send something...

```ts twoslash
import { format, bold, link, italic, spoiler, Bot } from "gramio";

const bot = new Bot("");
// ---cut---
bot.api.sendMessage({
    chat_id: 12321,
    text: format`${bold`Hi!`}

		Can ${italic("you")} help ${spoiler`me`}?
	
			Can you give me a ${link("star", "https://github.com/gramiojs/gramio")}?`,
});
```

![format](/formatting/format.png)

## FormatSaveIndents

Template literal that helps construct message entities for text formatting.

Use if you want to save all of the indentation.

> \[!IMPORTANT]
> For formatting with **arrays** always use the [`join`](#join) helper — never native `.join()`.

```ts twoslash
import { formatSaveIndents, bold, link, italic, spoiler, Bot } from "gramio";

const bot = new Bot("");
// ---cut---
bot.api.sendMessage({
    chat_id: 12321,
    text: formatSaveIndents`${bold`Hi!`}

		Can ${italic("you")} help ${spoiler`me`}?
	
			Can you give me a ${link("star", "https://github.com/gramiojs/gramio")}?`,
});
```

![format-save-indents](/formatting/format-save-indents.png)

## Entities

### **Bold**

Format text as **bold**. Cannot be combined with `code` and `pre`.

```ts twoslash
import { format, bold } from "@gramio/format";
// ---cut---
format`Format text as ${bold`bold`}`;
```

![bold example](/formatting/bold.png)

### *Italic*

Format text as *italic*. Cannot be combined with `code` and `pre`.

```ts twoslash
import { format, italic } from "@gramio/format";
// ---cut---
format`Format text as ${italic`italic`}`;
```

![italic example](/formatting/italic.png)

### Underline

Format text as underline. Cannot be combined with `code` and `pre`.

```ts twoslash
import { format, underline } from "@gramio/format";
// ---cut---
format`Format text as ${underline`underline`}`;
```

![underline example](/formatting/underline.png)

### ~~Strikethrough~~

Format text as ~~strikethrough~~. Cannot be combined with `code` and `pre`.

```ts twoslash
import { format, strikethrough } from "@gramio/format";
// ---cut---
format`Format text as ${strikethrough`strikethrough`}`;
```

![strikethrough example](/formatting/strikethrough.png)

### Spoiler

Format text as spoiler. Cannot be combined with `code` and `pre`.

```ts twoslash
import { format, spoiler } from "@gramio/format";
// ---cut---
format`Format text as ${spoiler`spoiler`}`;
```

![spoiler example](/formatting/spoiler.png)

> ### Blockquote

Format text as blockquote. Cannot be nested.

```ts twoslash
import { format, blockquote } from "@gramio/format";
// ---cut---
format`Format text as ${blockquote`blockquote`}`;
```

![blockquote example](/formatting/blockquote.png)

> ### Expandable blockquote

Format text as expandable blockquote. Cannot be nested.

```ts twoslash
import { format, expandableBlockquote } from "@gramio/format";
function loremIpsum(options: { count: number }): string {
    return "";
}
// ---cut---
format`Format text as ${expandableBlockquote(loremIpsum({ count: 20 }))}`;
```

![expandable blockquote example](/formatting/expandable_blockquote.png)

### `Code`

Format text as `code`. Convenient for copied items. Cannot be combined with any other format.

```ts twoslash
import { format, code } from "@gramio/format";
// ---cut---
format`Format text as ${code`code`}`;
```

![code example](/formatting/code.png)

### `Pre`

Format text as `pre`. Cannot be combined with any other format. ([Supported languages](https://github.com/TelegramMessenger/libprisma#supported-languages))

```ts twoslash
import { format, pre } from "@gramio/format";
// ---cut---
format`Format text as ${pre`pre`}`;
// or with language
format`Format text as ${pre(`console.log("pre with language")`, "js")}`;
```

![pre example](/formatting/pre.png)

### [Link](https://github.com/gramiojs/gramio)

Format text as [link](https://github.com/gramiojs/gramio). Cannot be combined with `code` and `pre`.

```ts twoslash
import { format, link } from "@gramio/format";
// ---cut---
format`Format text as ${link("link", "https://github.com/gramiojs/gramio")}`;
```

![link example](/formatting/link.png)

### [Mention](https://github.com/gramiojs/gramio)

Format text as [mention](https://github.com/gramiojs/gramio). Cannot be combined with `code` and `pre`.

```ts twoslash
import { format, mention } from "@gramio/format";
// ---cut---
format`format text as ${mention("mention", {
    id: 12312312,
    is_bot: false,
    first_name: "GramIO",
})}`;
```

![mention example](/formatting/mention.png)

### 🄲 🅄 🅂 🅃 🄾 🄼 ㅤ🄴 🄼 🄾 🄹 🄸

Insert custom emoji by their id.

```ts twoslash
import { format, customEmoji } from "@gramio/format";
// ---cut---
format`text with emoji - ${customEmoji("⚔️", "5222106016283378623")}`;
```

> \[!WARNING]
> Telegram now allows custom emoji for all bots **if** the bot owner has Telegram Premium **and** one of the following is true:
>
> * the message is in the bot's private chat (DM) or a regular chat **(not channels)**, or
> * it's an inline query result where you edit the sent message afterwards (custom emoji aren't allowed in the initial inline result; edit the message to apply them).
>   Previously this was only available to bots that paid for additional usernames (Fragment). Now the username purchase is no longer required under the conditions above.

## Composing format templates

`format` returns a **Formattable** object — not a plain string. It tracks both the text and entity offsets. You can store it in a variable and embed it in another `format` template; entities will be correctly re-offset.

```ts twoslash
import { format, bold, italic } from "@gramio/format";
// ---cut---
// ✅ Store result in a variable, then embed it
const greeting = format`Hello, ${bold`World`}!`;
const message = format`${greeting} ${italic`How are you?`}`;
// Bold entity from `greeting` is correctly shifted inside `message`
```

> \[!WARNING]
> **Never interpolate a Formattable into a plain template literal.** Calling `.toString()` (which happens in `` `${formattable}` ``) discards all entities and produces a plain string:
>
> ```ts
> // ❌ Wrong — entities are lost
> const a = `Hello, ${bold`World`}`;    // bold is stripped to plain text
> const b = `${a} and ${italic`more`}`; // italic survives, bold is gone
>
> // ✅ Correct — always use format``
> const a = format`Hello, ${bold`World`}`;
> const b = format`${a} and ${italic`more`}`;
> ```

## Helpers

### Join

Helper for correct formatting of arrays. Native `Array.prototype.join()` converts each element to a string via `.toString()`, which **destroys all entity data**.

> \[!WARNING]
> **Do not use `[...].join()` with formattable values.** Each entity function returns a Formattable object. Calling `.join()` on an array of them discards every entity, producing plain unstyled text:
>
> ```ts
> // ❌ Wrong — every bold/italic/etc. is silently stripped
> const text = items.map((x) => bold(x)).join(", ");
>
> // ✅ Correct — use the join helper
> const text = join(items, (x) => bold(x), ", ");
> ```

Separator by default is `, `

```ts twoslash
import { format, join, bold } from "@gramio/format";
// ---cut---
format`${join(["test", "other"], (x) => format`${bold(x)}`, "\n")}`;
```

## HTML

You can convert HTML markup into Telegram entities using the `htmlToFormattable` function from `@gramio/format/html` sub-module.

This is useful when your content comes from a CMS, rich text editor (TipTap, ProseMirror), or an LLM that produces HTML output. The approach is the same as Markdown: parse locally into entities and send without any `parse_mode`. Invalid HTML degrades gracefully to plain text.

> \[!WARNING]
> This function may change in the future.

### Installation

The HTML feature requires [`node-html-parser`](https://www.npmjs.com/package/node-html-parser) as a peer dependency:

::: pm-add node-html-parser
:::

### Usage

```ts
import { htmlToFormattable } from "@gramio/format/html";
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN!);

bot.command("start", (ctx) => {
    const html = `<h1>Hello!</h1>
<p><strong>Bold</strong> and <em>italic</em></p>
<ul><li>item one</li><li>item two</li></ul>
<p>Visit <a href="https://gramio.dev">gramio.dev</a></p>`;

    ctx.send(htmlToFormattable(html));
});
```

### Supported syntax

| HTML | Telegram entity |
|---|---|
| `<b>`, `<strong>` | bold |
| `<i>`, `<em>` | italic |
| `<u>` | underline |
| `<s>`, `<del>`, `<strike>` | strikethrough |
| `` `<code>` `` | code |
| `<pre><code class="language-js">` | pre (with language) |
| `<blockquote>` | blockquote |
| `<a href="...">` | text\_link |
| `<h1>`–`<h6>` | bold |
| `<ul>`, `<ol>`, `<li>` | plain text with bullet/number |
| `<br>` | newline |

## Markdown

You can convert standard Markdown text into Telegram entities using the `markdownToFormattable` function from `@gramio/format/markdown` sub-module.

This is especially useful for:

* **LLM output** — language models (ChatGPT, Claude, etc.) naturally produce standard Markdown. You can pass their output directly to `markdownToFormattable` and send it to Telegram with proper formatting.
* **Data from databases or external sources** — when you store or receive Markdown text and need to render it in Telegram.

Unlike Telegram's built-in `parse_mode` (`HTML` or `MarkdownV2`), this approach **won't break your message if the markup is invalid**. Telegram's `parse_mode` will reject the entire message on a syntax error (e.g. an unclosed tag or unescaped character). With `markdownToFormattable`, the text is parsed locally into entities — if the markdown is malformed, it gracefully degrades to plain text instead of failing.

> \[!WARNING]
> This function may change in the future.

### Installation

The markdown feature requires [`marked`](https://www.npmjs.com/package/marked) as a peer dependency:

::: pm-add marked
:::

### Usage

```ts
import { markdownToFormattable } from "@gramio/format/markdown";
import { Bot } from "gramio";

const bot = new Bot("");

bot.command("start", (context) => {
    context.send(
        markdownToFormattable(`**Hello** *world*!

> This is a blockquote

- **Bold** list item
- *Italic* list item
- [Link](https://gramio.dev)

\`\`\`js
console.log("code block with syntax highlighting")
\`\`\`
`)
    );
});
```

### Supported syntax

| Markdown | Telegram entity |
|---|---|
| `**bold**` | bold |
| `*italic*` | italic |
| `~~strikethrough~~` | strikethrough |
| `` `inline code` `` | code |
| ` ```lang ... ``` ` | pre (with language) |
| `[text](url)` | text\_link |
| `![alt](url)` | text\_link (images become links) |
| `> blockquote` | blockquote |
| `# Heading` | bold (all levels) |
| `- item` / `1. item` | plain text with prefix |

```
```

---

---
url: 'https://gramio.dev/get-started.md'
---

# Get Started

Build your first Telegram bot in **under a minute** — type-safe, multi-runtime, with a rich plugin ecosystem.

## 1. Get your bot token

Open [@BotFather](https://t.me/BotFather) in Telegram, send `/newbot`, and follow the prompts. You'll get a token like:

```
110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw
```

## 2. Scaffold your project

One command sets up everything — TypeScript, linting, ORM, plugins, Docker — your choice.

::: pm-create gramio@latest ./bot
:::

::: details What's included in the scaffolder?

* **ORMs** — [Prisma](https://www.prisma.io/), [Drizzle](https://orm.drizzle.team/)
* **Linters** — [Biome](https://biomejs.dev/), [ESLint](https://eslint.org/) (with relevant plugins auto-configured)
* **Official plugins** — [Scenes](/plugins/official/scenes), [Session](/plugins/official/session), [I18n](/plugins/official/i18n), [Autoload](/plugins/official/autoload), [Prompt](/plugins/official/prompt), [Auto-retry](/plugins/official/auto-retry), [Media-cache](/plugins/official/media-cache), [Media-group](/plugins/official/media-group)
* **Other** — Dockerfile + docker-compose, [Husky](https://typicode.github.io/husky/) git hooks, [Jobify](https://github.com/kravetsone/jobify) (BullMQ wrapper), [GramIO storages](/storages)
  :::

## 3. Start developing

Your bot is live and hot-reloading. **That's it.** Now let's see what you can build.

***

## What GramIO looks like

### Handle commands

```ts twoslash
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .command("start", (ctx) => ctx.send("Hello! 👋"))
    .command("help", (ctx) => ctx.send("Here's what I can do..."))
    .onStart(({ info }) => console.log(`Running as @${info.username}`));

bot.start();
```

### Format messages

No `parse_mode` — GramIO uses tagged template literals that produce proper `MessageEntity` objects automatically:

```ts twoslash
import { Bot, format, bold, italic, link, code } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .command("start", (ctx) =>
        ctx.send(
            format`${bold`Welcome to the bot!`}
            Check out ${link("GramIO", "https://gramio.dev")} — ${italic("type-safe all the way down")}.`
        )
    );

bot.start();
```

### Build keyboards

Fluent chainable API for inline and reply keyboards:

```ts twoslash
import { Bot, InlineKeyboard } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .command("menu", (ctx) =>
        ctx.send("What would you like to do?", {
            reply_markup: new InlineKeyboard()
                .text("About", "about")
                .url("GitHub", "https://github.com/gramiojs/gramio")
                .row()
                .text("Settings ⚙️", "settings"),
        })
    );

bot.start();
```

### Inject type-safe context with `derive`

Enrich every handler with your own data — no casting, fully typed:

```ts twoslash
// @filename: db.ts
export const db = { getUser: async (id: number) => ({ name: "Alice", id }) };

// @filename: index.ts
// ---cut---
import { Bot } from "gramio";
import { db } from "./db";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .derive("message", async (ctx) => ({
        user: await db.getUser(ctx.from!.id),
    }))
    .on("message", (ctx) => {
        ctx.user;
        //   ^?
        //
        //
        //
        //
        return ctx.send(`Hi, ${ctx.user.name}!`);
    });

bot.start();
```

### Middleware pipeline with Composer

`Bot` extends [Composer](/extend/composer) — a chainable type-safe middleware pipeline. Every method enriches the context and returns the updated type, so the chain is always fully typed.

`Composer` also exists as a **standalone class** you can import and use independently of `Bot`. This matters a lot once your project grows:

| Method | What it does |
|--------|-------------|
| `use(ctx, next)` | Raw middleware — call `next()` to continue |
| `derive(fn)` | Async per-request context enrichment |
| `decorate(obj)` | Static enrichment at startup — zero per-request overhead |
| `guard(fn)` | Only continue if predicate returns `true` |
| `on(event, fn)` | Handle a specific update type |
| `extend(composer)` | Merge another composer in — inheriting its full types |

#### Production pattern: shared plugin composer

In a real project, register all your plugins **once** in a shared `Composer`, then extend it in every feature file. Each handler file becomes a plain `Composer` — no `Bot` import, no token, fully testable:

```ts
// src/plugins/index.ts
import { Composer } from "gramio";
import { scenes } from "@gramio/scenes";
import { session } from "@gramio/session";
import { greetingScene } from "../scenes/greeting.ts";

export const composer = new Composer()
    .extend(scenes([greetingScene]))
    .extend(session());
```

```ts
// src/features/start.ts
import { Composer } from "gramio";
import { composer } from "../plugins/index.ts";

export const startFeature = new Composer()
    .extend(composer) // ← inherits all plugin types
    .command("start", (ctx) => {
        ctx.scene; // ✅ fully typed — no Bot, no token needed
        return ctx.scene.enter(greetingScene);
    });
```

```ts
// src/index.ts
import { Bot } from "gramio";
import { composer } from "./plugins/index.ts";
import { startFeature } from "./features/start.ts";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(composer)      // plugins
    .extend(startFeature); // feature handlers

bot.start();
```

::: tip Why this works
`Composer` carries its type through every `.extend()`. When `startFeature` extends `composer`, TypeScript sees all the properties that plugins added — `ctx.scene`, `ctx.session`, etc. — without any casting or manual type annotation.
:::

### Extend with plugins

Plugins are installed with `.extend()`. They can add new context properties, register handlers, and hook into the lifecycle — all fully typed.

Here's how to add [Scenes](/plugins/official/scenes) for multi-step conversation flows:

::: pm-add @gramio/scenes
:::

```ts twoslash
import { Bot } from "gramio";
import { scenes, Scene } from "@gramio/scenes";

const registrationScene = new Scene("registration")
    .step("message", (ctx) => {
        if (ctx.scene.step.firstTime) return ctx.send("What's your name?");
        return ctx.scene.update({ name: ctx.text });
    })
    .step("message", (ctx) => {
        ctx.scene.state;
        //          ^?
        //
        //
        //
        //
        return ctx.send(`Nice to meet you, ${ctx.scene.state.name}!`);
    });

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(scenes([registrationScene]))
    .command("start", (ctx) => ctx.scene.enter(registrationScene));

bot.start();
```

Each `.step()` is triggered by the next matching update from the same user. State is persisted across steps and fully typed.

***

## Official plugins

Extend your bot with first-party plugins that integrate seamlessly:

| Plugin | What it does |
|--------|-------------|
| [Session](/plugins/official/session) | Per-user state that persists between messages |
| [Scenes](/plugins/official/scenes) | Multi-step conversation flows and wizards |
| [I18n](/plugins/official/i18n) | Internationalization powered by Fluent |
| [Autoload](/plugins/official/autoload) | Auto-import handlers from the filesystem |
| [Auto-retry](/plugins/official/auto-retry) | Automatic retry on rate-limit errors |
| [Media-cache](/plugins/official/media-cache) | Cache uploaded file IDs to avoid re-uploads |
| [Media-group](/plugins/official/media-group) | Treat album updates as a single event |
| [Views](/plugins/official/views) | JSX-based message rendering |
| [Prompt](/plugins/official/prompt) | Wait for the next user message inline |
| [OpenTelemetry](/plugins/official/opentelemetry) | Distributed tracing and metrics |
| [Sentry](/plugins/official/sentry) | Error tracking and monitoring |

[Browse all plugins →](/plugins/overview)

***

## Manual setup

Prefer to wire things up yourself?

::: pm-add gramio
:::

Create `src/index.ts`:

::: code-group

```ts twoslash [Node.js / Bun]
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .command("start", (ctx) => ctx.send("Hi! 👋"))
    .onStart(console.log);

bot.start();
```

```ts [Deno]
import { Bot } from "jsr:@gramio/core";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .command("start", (ctx) => ctx.send("Hi! 👋"))
    .onStart(console.log);

bot.start();
```

:::

And run it:

::: code-group

```bash [tsx]
npx tsx ./src/index.ts
```

```bash [bun]
bun ./src/index.ts
```

```bash [deno]
deno run --allow-net --allow-env ./src/index.ts
```

:::

---

---
url: 'https://gramio.dev/updates/graceful-shutdown.md'
---
# Graceful shutdown

Graceful shutdown - pattern which helps to stop the application without losing data or killing running processes (for example, response to `/start`).

> What are your last words?

### Signals

* `SIGINT` (Signal Interrupt)

This signal sended when user presses Ctrl+C.

* `SIGTERM` (Signal Terminate)

This signal is often sent by process managers (like Docker, Kubernetes, or systemd) when they need to terminate a process.

so we want to handle both.

### Example

Imagine you have a **bot** on **webhooks** with **analytics** usage.

```ts
import { app } from "./webhook";
import { bot } from "./bot";
import { posthog } from "./analytics";

const signals = ["SIGINT", "SIGTERM"];

for (const signal of signals) {
    process.on(signal, async () => {
        console.log(`Received ${signal}. Initiating graceful shutdown...`);
        await app.stop();
        await bot.stop();
        await posthog.shutdown();
        process.exit(0);
    });
}
```

For first, we should stop receiving updates - gracefully stop our backend API framework (for example, Elysia).

For second, we should process all pending updates - gracefully stop our bot with `bot.stop` method.

and last, we should call `posthog.shutdown()` which send captured analytics to our PostHog instance.

then we exit our process with 0 status code and it all!

this example shows how to gracefully shutdown your bot in right order for most applications.

---

---
url: 'https://gramio.dev/api.md'
description: >-
  TypeScript API reference auto-generated from source .d.ts files of all GramIO
  packages — classes, interfaces, types, and methods.
---

# GramIO API Reference

TypeScript API reference auto-generated from the `.d.ts` files of all GramIO packages. Browse classes, interfaces, type aliases, and their full signatures.

> **Tip:** Looking for Telegram Bot API types and method parameters? See the [Telegram API Reference](/telegram/) which documents the official Bot API from a Telegram perspective.

## Core Packages

| Package | Description |
|---------|-------------|
| [gramio](/api/gramio/) | Main `Bot` class and core re-exports |
| [@gramio/contexts](/api/contexts/) | All context classes (`MessageContext`, `CallbackQueryContext`, etc.) — **most important for bot development** |
| [@gramio/keyboards](/api/keyboards/) | `Keyboard`, `InlineKeyboard`, `RemoveKeyboard`, `ForceReply` builders |
| [@gramio/files](/api/files/) | `MediaUpload`, `MediaInput` — file upload helpers |
| [@gramio/format](/api/format/) | `format`, `bold`, `italic`, `code`, and other text formatting utilities |
| [@gramio/callback-data](/api/callback-data/) | `CallbackData` — type-safe callback data builder |
| [@gramio/composer](/api/composer/) | `Composer` — standalone middleware composer |

## Plugin Packages

| Package | Description |
|---------|-------------|
| [@gramio/scenes](/api/scenes/) | Scene-based conversation flows |
| [@gramio/session](/api/session/) | Session storage plugin |
| [@gramio/storage](/api/storage/) | Storage adapter interface |
| [@gramio/i18n](/api/i18n/) | Internationalization plugin |
| [@gramio/autoload](/api/autoload/) | Auto-load handlers from files |
| [@gramio/auto-retry](/api/auto-retry/) | Automatic retry on Telegram API errors |
| [@gramio/prompt](/api/prompt/) | Prompt for user input within handlers |
| [@gramio/init-data](/api/init-data/) | Telegram Mini App init data validation |

## Most-Used Classes

Quick links to the most frequently referenced types:

* [`MessageContext`](/api/contexts/classes/MessageContext) — handler context for incoming messages
* [`InlineKeyboard`](/api/keyboards/classes/InlineKeyboard) — inline keyboard builder
* [`Keyboard`](/api/keyboards/classes/Keyboard) — reply keyboard builder
* [`Bot`](/api/gramio/classes/Bot) — main bot class
* [`format`](/api/format/functions/format) — tagged template literal for formatting

## Generation

These pages are auto-generated by [TypeDoc](https://typedoc.org) with `typedoc-plugin-markdown` and `typedoc-vitepress-theme`.

Run locally:

```bash
bun run gen:typedoc
```

---

---
url: 'https://gramio.dev/cheat-sheet.md'
---

# Cheat Sheet

Quick reference for the most common GramIO patterns. Click any heading to go to the full docs.

**On this page:** [Setup](#setup) · [Commands](#commands) · [Hears](#hears) · [Any update](#listen-to-any-update) · [Derive & Decorate](#derive-decorate) · [Guards](#guards) · [Inline Keyboard](#inline-keyboard) · [Callback Query](#callback-query) · [Reply Keyboard](#reply-keyboard) · [Formatting](#format-messages) · [Files](#send-files) · [Session](#session) · [Scenes](#scenes-conversations) · [I18n](#i18n) · [Error Handling](#error-handling) · [Hooks](#hooks) · [Plugins](#use-a-plugin) · [Write Plugin](#write-a-plugin) · [Inline Query](#inline-query) · [Autoload](#autoload-handlers) · [Testing](#testing) · [Webhook](#webhook)

***

## [Setup](/get-started)

```bash
npm create gramio my-bot
```

```ts
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string);

bot.start();
```

***

## [Commands](/triggers/command)

```ts
bot.command("start", (ctx) => ctx.send("Hello!"));

// With arguments: /say hello world → ctx.args = "hello world"
bot.command("say", (ctx) => ctx.send(ctx.args ?? "nothing"));
```

***

## [Hears](/triggers/hears)

```ts
// Exact string
bot.hears("hi", (ctx) => ctx.send("Hey!"));

// Regex — ctx.args holds the match array
bot.hears(/^hello (.+)/i, (ctx) => ctx.send(`Hi, ${ctx.args?.[1]}!`));

// Function predicate
bot.hears(
    (ctx) => ctx.text?.startsWith("?"),
    (ctx) => ctx.send("A question!"),
);
```

***

## [Listen to any update](/bot-api)

```ts
bot.on("message", (ctx) => ctx.send("Got your message!"));

bot.on(["message", "edited_message"], (ctx) => ctx.send("New or edited!"));
```

***

## [Derive & Decorate](/extend/middleware)

`derive` runs per-request; `decorate` runs once at startup.

```ts
// Per-request: enriches ctx with fresh data each time
const bot = new Bot(token)
    .derive(async (ctx) => ({
        user: await db.getUser(ctx.from?.id),
    }))
    .on("message", (ctx) => {
        ctx.user; // fully typed ✅
    });
```

```ts
// Per-update-type: only for specific events
const bot = new Bot(token)
    .derive("message", async (ctx) => ({
        isAdmin: await db.isAdmin(ctx.from.id),
    }))
    .on("message", (ctx) => {
        ctx.isAdmin; // ✅ — only typed on "message" handlers
    });
```

```ts
// Startup-time: no per-request overhead
const bot = new Bot(token)
    .decorate({ db, redis, config })
    .on("message", (ctx) => {
        ctx.db.query("..."); // ✅ — same instance every time
    });
```

***

## [Guards](/extend/middleware)

Stop the middleware chain when a condition isn't met. Downstream handlers only run if the guard passes.

```ts
// Reusable admin guard
const adminOnly = bot.guard(
    (ctx) => ctx.from?.id === ADMIN_ID,
    // optional rejection handler:
    (ctx) => ctx.send("Admins only."),
);

adminOnly.command("ban", (ctx) => ctx.send("User banned."));
```

```ts
// Narrow update type — filter for messages with text
const textOnly = bot.guard((ctx) => ctx.is("message") && !!ctx.text);

textOnly.on("message", (ctx) => {
    ctx.text; // string — narrowed by the guard ✅
});
```

***

## [Inline Keyboard](/keyboards/inline-keyboard)

```ts
import { InlineKeyboard, CallbackData } from "gramio";

// Simple text buttons
const keyboard = new InlineKeyboard()
    .text("Yes ✅", "yes")
    .text("No ❌", "no")
    .row()
    .url("GitHub", "https://github.com/gramiojs/gramio");

ctx.send("Choose:", { reply_markup: keyboard });
```

```ts
// Type-safe callback data
const actionData = new CallbackData("action").number("id");

ctx.send("Pick one:", {
    reply_markup: new InlineKeyboard()
        .text("Item 1", actionData.pack({ id: 1 }))
        .text("Item 2", actionData.pack({ id: 2 })),
});
```

***

## [Callback Query](/triggers/callback-query)

```ts
// String match
bot.callbackQuery("yes", (ctx) => ctx.editText("You said yes!"));

// Type-safe CallbackData
const actionData = new CallbackData("action").number("id");

bot.callbackQuery(actionData, (ctx) => {
    ctx.send(`You picked ID: ${ctx.queryData.id}`);
    //                                      ^? number
});
```

***

## [Reply Keyboard](/keyboards/keyboard)

```ts
import { Keyboard } from "gramio";

const keyboard = new Keyboard()
    .text("Option A")
    .text("Option B")
    .row()
    .requestLocation("Share location 📍")
    .resized();

ctx.send("Choose:", { reply_markup: keyboard });
```

***

## [Remove Keyboard](/keyboards/remove-keyboard)

```ts
import { RemoveKeyboard } from "gramio";

ctx.send("Keyboard removed.", { reply_markup: new RemoveKeyboard() });
```

***

## [Format Messages](/formatting)

```ts
import { format, bold, italic, link, code, pre, spoiler } from "gramio";

ctx.send(format`
    ${bold`Hello!`} Welcome to ${link("GramIO", "https://gramio.dev")}.

    Here is some ${italic`styled`} text and a ${spoiler`surprise`}.

    ${code("inline code")} or a block:
    ${pre("const x = 1;", "typescript")}
`);
```

***

## [Send Files](/files/media-upload)

```ts
import { MediaUpload } from "@gramio/files";

// From disk
ctx.sendDocument(await MediaUpload.path("./report.pdf"));

// From URL
ctx.sendPhoto(await MediaUpload.url("https://example.com/cat.png"));

// From Buffer
ctx.sendDocument(await MediaUpload.buffer(buffer, "file.pdf"));

// By file_id (already uploaded to Telegram)
ctx.sendPhoto("AgACAgIAAxk...");
```

***

## [Session](/plugins/official/session)

```ts
import { session } from "@gramio/session";

const bot = new Bot(process.env.BOT_TOKEN as string).extend(
    session({
        key: "session",
        initial: () => ({ count: 0 }),
    }),
);

bot.command("count", (ctx) => {
    ctx.session.count++;
    //    ^? { count: number }
    ctx.send(`Count: ${ctx.session.count}`);
});
```

***

## [Scenes (conversations)](/plugins/official/scenes)

```ts
import { Scene, scenes } from "@gramio/scenes";
import { session } from "@gramio/session";

const loginScene = new Scene("login")
    .step("message", (ctx) => {
        if (ctx.scene.step.firstTime) return ctx.send("Enter your email:");
        return ctx.scene.update({ email: ctx.text });
    })
    .step("message", (ctx) => ctx.send(`Registered: ${ctx.scene.state.email}`));

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(session())
    .extend(scenes([loginScene]));

bot.command("login", (ctx) => ctx.scene.enter(loginScene));
```

***

## [I18n](/plugins/official/i18n)

```ts
import {
    defineI18n,
    type LanguageMap,
    type ShouldFollowLanguage,
} from "@gramio/i18n";
import { format, bold } from "gramio";

const en = {
    welcome: (name: string) => format`Hello, ${bold(name)}!`,
    items: (count: number) => `You have ${count} item${count === 1 ? "" : "s"}`,
} satisfies LanguageMap;

const ru = {
    welcome: (name: string) => format`Привет, ${bold(name)}!`,
    items: (count: number) =>
        `У вас ${count} предмет${count === 1 ? "" : "ов"}`,
} satisfies ShouldFollowLanguage<typeof en>; // must match en keys/signatures

const i18n = defineI18n({ primaryLanguage: "en", languages: { en, ru } });

const bot = new Bot(token).derive((ctx) => ({
    t: i18n.buildT(ctx.from?.language_code ?? "en"),
}));

bot.command("start", (ctx) =>
    ctx.send(ctx.t("welcome", ctx.from?.firstName ?? "stranger")),
);
```

***

## [Error Handling](/hooks/on-error)

```ts
// Catch all errors
bot.onError(({ context, kind, error }) => {
    console.error(kind, error.message);
    if (context.is("message")) context.send("Something went wrong.");
});

// Only for specific update types
bot.onError("message", ({ context, kind, error }) => {
    context.send(`${kind}: ${error.message}`);
});

// Custom typed errors
class NoRights extends Error {
    constructor(public role: "admin" | "moderator") {
        super();
    }
}

const bot = new Bot(process.env.BOT_TOKEN as string)
    .error("NO_RIGHTS", NoRights)
    .onError(({ kind, error, context }) => {
        if (kind === "NO_RIGHTS" && context.is("message"))
            context.send(`You need the «${error.role}» role.`);
    });
```

***

## [Hooks](/hooks/overview)

```ts
bot.onStart((info) => console.log(`@${info.username} is running!`));

bot.onStop(() => console.log("Shutting down..."));

// Intercept every API request
bot.preRequest((ctx) => {
    console.log("Calling", ctx.method);
    return ctx;
});

// Inspect every response
bot.onResponse((ctx) => {
    console.log(ctx.method, "→", ctx.response);
    return ctx;
});
```

***

## [Use a Plugin](/plugins/overview)

```ts
import { autoAnswerCallbackQuery } from "@gramio/auto-answer-callback-query";

bot.extend(autoAnswerCallbackQuery());
```

***

## [Write a Plugin](/plugins/how-to-write)

```ts
import { Plugin } from "gramio";

const myPlugin = new Plugin("my-plugin").derive("message", (ctx) => ({
    isAdmin: ctx.from?.id === 123456789,
}));

bot.extend(myPlugin);

bot.on("message", (ctx) => {
    if (ctx.isAdmin) ctx.send("Hi boss!");
    //     ^? boolean
});
```

***

## [Inline Query](/triggers/inline-query)

```ts
bot.inlineQuery("cats", async (ctx) => {
    await ctx.answer(
        [
            ctx.buildInlineQueryResult.article({
                id: "1",
                title: "Cat fact",
                input_message_content: { message_text: "Cats purr at 25Hz." },
            }),
        ],
        { cache_time: 30 },
    );
});
```

***

## [Autoload handlers](/plugins/official/autoload)

```ts
import { autoload } from "@gramio/autoload";

// Loads all files from ./src/commands/**/*.ts automatically
const bot = new Bot(process.env.BOT_TOKEN as string).extend(autoload());
```

```ts
// src/commands/start.ts
import type { Bot } from "gramio";

export default (bot: Bot) => bot.command("start", (ctx) => ctx.send("Hi!"));
```

***

## [Testing](/testing)

```ts
import { describe, expect, it } from "bun:test";
import { Bot } from "gramio";
import { TelegramTestEnvironment } from "@gramio/test";

const bot = new Bot("test");
bot.command("start", (ctx) => ctx.send("Hello!"));

const env = new TelegramTestEnvironment(bot);
const user = env.createUser({ first_name: "Alice" });

// Simulate a /start command
await user.sendMessage("/start");

// Assert the response
expect(env.apiCalls[0].method).toBe("sendMessage");
expect(env.apiCalls[0].params.text).toBe("Hello!");
```

***

## [Webhook](/updates/webhook)

GramIO has no built-in HTTP server — bring your own framework and use `webhookHandler`:

```ts
import { Bot, webhookHandler } from "gramio";
import Fastify from "fastify";

const bot = new Bot(process.env.BOT_TOKEN as string);
const fastify = Fastify();

fastify.post("/webhook", webhookHandler(bot, "fastify"));
fastify.listen({ port: 3000, host: "::" });

bot.start({
    webhook: { url: "https://example.com/webhook" },
});
```

See [all supported frameworks →](/updates/webhook) (Hono, Express, Elysia, Koa, Bun.serve, Deno.serve, node:http)

---

---
url: 'https://gramio.dev/plugins/overview.md'
---

# Plugins Overview

GramIO's plugin system is built on the same `.extend()` mechanism that powers the whole framework. Every plugin composes cleanly — plugins can add context properties, register handlers, and hook into the bot lifecycle, all with **full type propagation** to every downstream handler.

```ts
const bot = new Bot(token)
    .extend(session())       // ctx.session is now typed
    .extend(scenes([...]))   // ctx.scene is now typed
    .extend(i18n())          // ctx.i18n is now typed
    .on("message", (ctx) => {
        ctx.session; // ✅
        ctx.scene;   // ✅
        ctx.i18n;    // ✅
    });
```

***

## Official Plugins

### [Scenes](/plugins/official/scenes) — `@gramio/scenes`

Multi-step conversation flows. Build wizards, onboarding sequences, and multi-step forms where each step waits for the user's next message.

* Steps are typed: state flows from step to step
* Enter a scene from any handler; exit or jump to any step
* Works with session for persistent state across restarts

```ts
const registerScene = new Scene("register")
    .step("message", (ctx) => {
        if (ctx.scene.step.firstTime) return ctx.send("What's your name?");
        return ctx.scene.update({ name: ctx.text });
    })
    .step("message", (ctx) => ctx.send(`Welcome, ${ctx.scene.state.name}!`));
```

[Full docs →](/plugins/official/scenes)

***

### [Session](/plugins/official/session) — `@gramio/session`

Per-user persistent state across messages. Reads and writes are transparent — just use `ctx.session` like a plain object.

* In-memory by default; plug in any [storage adapter](/storages)
* Initial state factory is typed end-to-end
* Works great with Scenes for storing scene state

```ts
const bot = new Bot(token).extend(
    session({ initial: () => ({ count: 0, name: "" }) }),
);

bot.command("count", (ctx) => {
    ctx.session.count++;
    return ctx.send(`Count: ${ctx.session.count}`);
});
```

[Full docs →](/plugins/official/session)

***

### [I18n](/plugins/official/i18n) — `@gramio/i18n`

TypeScript-native internationalization with **full compile-time type safety** — no codegen, no `.ftl` files. Define translations as plain TS functions; `ShouldFollowLanguage` ensures every locale matches the primary language's keys and signatures.

* Translation values are plain functions — use `format`/`bold`/etc. directly
* Per-user locale from any source (database, session, Telegram `language_code`)
* Auto-completes keys and argument types in your editor
* Fluent `.ftl` support also available if you need advanced pluralization

```ts
import {
    defineI18n,
    type LanguageMap,
    type ShouldFollowLanguage,
} from "@gramio/i18n";
import { format, bold } from "gramio";

const en = {
    welcome: (name: string) => format`Hello, ${bold(name)}!`,
} satisfies LanguageMap;

const ru = {
    welcome: (name: string) => format`Привет, ${bold(name)}!`,
} satisfies ShouldFollowLanguage<typeof en>;

const i18n = defineI18n({ primaryLanguage: "en", languages: { en, ru } });

const bot = new Bot(token)
    // build a per-request t() scoped to the user's locale
    .derive((ctx) => ({
        t: i18n.buildT(ctx.from?.language_code ?? "en"),
    }));

bot.command("start", (ctx) =>
    ctx.send(ctx.t("welcome", ctx.from?.firstName ?? "stranger")),
);
```

[Full docs →](/plugins/official/i18n)

***

### [Autoload](/plugins/official/autoload) — `@gramio/autoload`

File-based handler registration. Drop a file in `src/commands/` and it registers automatically — no manual imports, no central registry.

* Glob pattern configurable (`src/commands/**/*.ts` by default)
* Each file exports a default function `(bot: Bot) => Bot`
* Works great with large bots split across many feature files

```ts
// src/index.ts
const bot = new Bot(token).extend(autoload());

// src/commands/start.ts
export default (bot: Bot) => bot.command("start", (ctx) => ctx.send("Hi!"));
```

[Full docs →](/plugins/official/autoload)

***

### [Prompt](/plugins/official/prompt) — `@gramio/prompt`

Awaitable single-reply prompts. Ask a question and `await` the user's response in a linear, readable flow — no need for state machines.

* Pauses execution and resumes when the user replies
* Optional timeout
* Pairs naturally with Scenes for complex flows

```ts
bot.command("rename", async (ctx) => {
    const reply = await ctx.prompt("What's your new name?");
    await ctx.send(`Name updated to: ${reply.text}`);
});
```

[Full docs →](/plugins/official/prompt)

***

### [Auto Retry](/plugins/official/auto-retry) — `@gramio/auto-retry`

Automatic handling of Telegram rate limits. When Telegram responds with `retry_after`, the plugin waits and retries transparently — no changes to your code needed.

* Handles `Too Many Requests` (429) errors automatically
* Configurable max retries and delay strategy
* Works for broadcasts, high-throughput bots

```ts
const bot = new Bot(token).extend(autoRetry());
// All API calls now retry automatically on rate limit
```

[Full docs →](/plugins/official/auto-retry)

***

### [Auto Answer Callback Query](/plugins/official/auto-answer-callback-query) — `@gramio/auto-answer-callback-query`

Never forget to acknowledge a callback query. Automatically answers all `callback_query` updates that weren't already answered — Telegram requires a response within 10 seconds or shows an error.

```ts
const bot = new Bot(token).extend(autoAnswerCallbackQuery());
// Now every inline button click is auto-acknowledged
```

[Full docs →](/plugins/official/auto-answer-callback-query)

***

### [Media Cache](/plugins/official/media-cache) — `@gramio/media-cache`

Upload a file once, reuse its `file_id` forever. Transparently caches `file_id` for uploaded media so Telegram doesn't re-upload the same file on every send.

* Works with any storage backend
* Reduces upload latency for repeated sends
* Transparent — no changes to send calls

[Full docs →](/plugins/official/media-cache)

***

### [Media Group](/plugins/official/media-group) — `@gramio/media-group`

Aggregate media group updates. Telegram sends `media_group` messages as individual updates. This plugin buffers them and delivers the full group to your handler as one event.

```ts
bot.on("message", (ctx) => {
    if (ctx.mediaGroup) {
        // ctx.mediaGroup is the full array of media group items
        ctx.send(`Got ${ctx.mediaGroup.length} photos`);
    }
});
```

[Full docs →](/plugins/official/media-group)

***

### [Pagination](/plugins/official/pagination) — `@gramio/pagination`

Typed paginated inline keyboards. Build multi-page lists with type-safe page data, next/prev buttons, and clean handler logic.

```ts
const paginationData = new CallbackData("page").number("offset");

const keyboard = pagination({
    data: paginationData,
    total: items.length,
    pageSize: 5,
    current: offset,
});
```

[Full docs →](/plugins/official/pagination)

***

### [Views](/plugins/official/views) — `@gramio/views`

Reusable message templates. Define a message (text + keyboard + options) once and render it anywhere, keeping UI and logic separate.

[Full docs →](/plugins/official/views)

***

### [JSX](/plugins/official/jsx) — `@gramio/jsx`

Write bot messages using JSX. Use familiar React-like syntax to compose rich messages with formatting entities.

```tsx
bot.command("start", (ctx) =>
    ctx.send(<b>Hello!</b> <i>Welcome to my bot.</i>)
);
```

[Full docs →](/plugins/official/jsx)

***

### [PostHog](/plugins/official/posthog) — `@gramio/posthog`

Analytics for your bot. Track user commands, events, and behavior in [PostHog](https://posthog.com/) with automatic event capture.

[Full docs →](/plugins/official/posthog)

***

### [OpenTelemetry](/plugins/official/opentelemetry) — `@gramio/opentelemetry`

Distributed tracing. Instrument your bot with [OpenTelemetry](https://opentelemetry.io/) spans for full observability — traces every API call, handler, and hook.

[Full docs →](/plugins/official/opentelemetry)

***

### [Sentry](/plugins/official/sentry) — `@gramio/sentry`

Error monitoring. Automatically captures unhandled errors and sends them to [Sentry](https://sentry.io/) with context (update type, user ID, etc.).

[Full docs →](/plugins/official/sentry)

***

### [Split](/plugins/official/split) — `@gramio/split`

Multi-instance routing. Split incoming updates across multiple bot instances or workers for high-throughput scenarios.

[Full docs →](/plugins/official/split)

***

## Which plugin do I need?

| Scenario                             | Use                                                                        |
| ------------------------------------ | -------------------------------------------------------------------------- |
| Multi-step forms / wizards           | [Scenes](/plugins/official/scenes)                                         |
| Store user preferences / state       | [Session](/plugins/official/session)                                       |
| Multi-language bot                   | [I18n](/plugins/official/i18n)                                             |
| Large bot with many command files    | [Autoload](/plugins/official/autoload)                                     |
| Ask a question, await response       | [Prompt](/plugins/official/prompt)                                         |
| Handle rate limits automatically     | [Auto Retry](/plugins/official/auto-retry)                                 |
| Avoid unacknowledged callback errors | [Auto Answer Callback Query](/plugins/official/auto-answer-callback-query) |
| Avoid re-uploading the same files    | [Media Cache](/plugins/official/media-cache)                               |
| Handle album/media group messages    | [Media Group](/plugins/official/media-group)                               |
| Paginated lists with inline buttons  | [Pagination](/plugins/official/pagination)                                 |
| Track user events and funnels        | [PostHog](/plugins/official/posthog)                                       |
| Error monitoring in production       | [Sentry](/plugins/official/sentry)                                         |
| Distributed tracing / observability  | [OpenTelemetry](/plugins/official/opentelemetry)                           |

***

## Stacking plugins

Plugins compose — extend your bot with as many as you need, and the types stay correct throughout:

```ts
const bot = new Bot(token)
    .extend(session({ initial: () => ({ locale: "en", name: "" }) }))
    .extend(i18n())
    .extend(scenes([registerScene]))
    .extend(autoAnswerCallbackQuery())
    .extend(autoRetry());

// In any handler: ctx.session, ctx.i18n, ctx.scene — all typed ✅
```

***

## Write your own plugin

Any `Composer` can be packaged as a plugin. The [`Plugin`](/plugins/how-to-write) class adds a name and a clean `.extend()` interface.

```ts
import { Plugin } from "gramio";

export const myPlugin = new Plugin("my-plugin").derive((ctx) => ({
    isAdmin: ctx.from?.id === ADMIN_ID,
}));

// In consuming bot:
bot.extend(myPlugin);
// ctx.isAdmin is now typed everywhere ✅
```

[How to write a plugin →](/plugins/how-to-write)

---

---
url: 'https://gramio.dev/changelogs/2026-02-17.md'
---

# GramIO v0.5.0 — Composer Rearchitecture, Observability & Testing Superpowers

**February 16–18, 2026**

This is a big engineering cycle. The headline: `gramio` v0.5.0 drops `middleware-io` entirely and builds on `@gramio/composer` v0.2.0 — a purpose-built, type-safe middleware composition library with a new observability layer, build-time conditionals, and static context decoration. On top of that, `@gramio/test` graduates to v0.1.0 with reactions, inline queries, and a fluent scope API that makes test scenarios read like user stories. Let's dig in.

## [gramio v0.5.0 — Farewell middleware-io](https://github.com/gramiojs/gramio/compare/v0.4.14...v0.5.0)

### [Core middleware engine replaced with @gramio/composer](https://github.com/gramiojs/gramio/commit/c129fae1e953afa9fd42566386a8be272b723c47)

The internal `middleware-io` dependency is gone. GramIO now uses `@gramio/composer` throughout, which means better deduplication, named middleware for meaningful stack traces, and the new observability API (`inspect()`, `trace()`) available everywhere.

The `UpdateQueue` class previously in `src/queue.ts` has also been removed — replaced by `EventQueue` from `@gramio/composer`.

### [Shorthand methods moved to Composer — plugins can now use them too](https://github.com/gramiojs/gramio/commit/58b0aaa0c2e7e6c6b6562820378c9e3b22b14153)

`reaction()`, `callbackQuery()`, `chosenInlineResult()`, `inlineQuery()`, `hears()`, `command()`, and `startParameter()` have moved from `Bot` into `Composer`. The `Bot` methods still exist — they delegate to the composer — but now plugins and standalone composers can use these shorthand methods directly.

```ts
// This now works inside a plugin, not just on Bot:
const myPlugin = new Plugin("my-plugin")
    .command("help", (ctx) => ctx.send("Help!"))
    .hears(/hello/i, (ctx) => ctx.send("Hi there!"));
```

### [Bot.extend(composer) and Plugin.extend(composer) overloads](https://github.com/gramiojs/gramio/commit/2d65314)

Both `Bot` and `Plugin` now accept `EventComposer` instances in their `extend()` method with proper type inference. Plugin composers are promoted to "scoped" mode so they can share context across extensions without duplicating middleware.

### [@gramio/types 9.4.1 and @gramio/composer 0.2.0](https://github.com/gramiojs/gramio/commit/58b0aaa0c2e7e6c6b6562820378c9e3b22b14153)

Dependencies updated: `@gramio/types` → 9.4.1, `@gramio/composer` → 0.2.0.

***

## [@gramio/composer v0.2.0 — Decorate, When, Inspect, Trace](https://github.com/gramiojs/composer/compare/v0.1.1...v0.2.0)

The composer library got a feature sprint. Here's everything new:

### [decorate() — zero-overhead static context enrichment](https://github.com/gramiojs/composer/commit/16eb20c46cbc635fbbec4b0e62f0243809a93366)

`derive()` runs a function per request. `decorate()` assigns a plain object once per middleware registration and reuses the same reference every time. No function call overhead at all.

```ts
const app = new Composer()
    .decorate({ db: myDbClient, config: appConfig })
    .use((ctx, next) => {
        ctx.db.query(/* ... */); // available on every request
        return next();
    });
```

Supports the same scope system as `derive()` — pass `{ as: "scoped" }` or `{ as: "global" }` to propagate into parent composers via `extend()`.

### [when() — build-time conditional middleware](https://github.com/gramiojs/composer/commit/16eb20c46cbc635fbbec4b0e62f0243809a93366)

Register middleware only when a condition is true at startup time. Unlike runtime `branch()`, `when()` evaluates the condition once when the bot boots. Properties added inside a `when()` block are typed as `Partial` (optional), since the block may not execute:

```ts
const bot = new Bot(token)
    .when(process.env.NODE_ENV !== "production", (c) =>
        c.use(verboseLogger)
    )
    .when(config.features.auth, (c) =>
        c.derive(() => ({ user: getUser() }))
    )
    .on("message", (ctx) => {
        ctx.user; // type: User | undefined (may not be set if feature is disabled)
    });
```

Nested `when()` blocks work. Dedup keys, error handlers, and error definitions from the conditional block all propagate correctly.

### [inspect() — read-only middleware metadata](https://github.com/gramiojs/composer/commit/08f764325d42938766c4822cb98ebe5849b6f292)

Get a full picture of what middleware is registered and where it came from:

```ts
const app = new Composer()
    .derive(function getUser() { return { user: "alice" }; })
    .guard(function isAdmin() { return true; })
    .use(async function handleRequest(_, next) { return next(); });

app.inspect();
// [
//   { index: 0, type: "derive", name: "getUser", scope: "local" },
//   { index: 1, type: "guard", name: "isAdmin", scope: "local" },
//   { index: 2, type: "use", name: "handleRequest", scope: "local" },
// ]
```

When you extend a named plugin, the `plugin` field shows origin:

```ts
const auth = new Composer({ name: "auth" })
    .derive(function getUser() { return { user: "alice" }; })
    .as("scoped");

new Composer().extend(auth).inspect();
// [{ index: 0, type: "derive", name: "getUser", scope: "local", plugin: "auth" }]
```

### [trace() — opt-in per-middleware instrumentation](https://github.com/gramiojs/composer/commit/08f764325d42938766c4822cb98ebe5849b6f292)

Wire up OpenTelemetry, Datadog, or any tracing system with a single callback. Zero overhead when not used — middleware functions are passed through unwrapped when no tracer is set:

```ts
const app = new Composer()
    .derive(function getUser() { /* ... */ })
    .use(handler)
    .trace((entry, ctx) => {
        const span = tracer.startSpan(`${entry.type}:${entry.name}`);
        return (error) => {
            if (error) span.recordException(error);
            span.end();
        };
    });
```

The cleanup function receives the error if middleware throws, then the error continues propagating to `onError`.

### [Custom methods config for createComposer()](https://github.com/gramiojs/composer/commit/9611bb5)

Framework authors can inject typed shorthand methods directly onto the `Composer` prototype via the `methods` config option. This is how `hears()`, `command()`, `reaction()`, etc. are now defined in GramIO itself:

```ts
const { Composer } = createComposer({
    discriminator: (ctx) => ctx.updateType,
    types: eventTypes<{ message: MessageCtx }>(),
    methods: {
        hears(trigger: RegExp | string, handler: (ctx: MessageCtx) => unknown) {
            return this.on("message", (ctx, next) => {
                const text = ctx.text;
                if (typeof trigger === "string" ? text === trigger : trigger.test(text ?? ""))
                    return handler(ctx);
                return next();
            });
        },
    },
});

// Custom methods are preserved through ALL chain methods:
bot.hears(/hello/, h1).on("message", h2).hears(/bye/, h3); // works
```

A runtime conflict check throws if a method name collides with a built-in (`on`, `use`, `derive`, etc.).

### [Function naming for stack traces](https://github.com/gramiojs/composer/commit/08f764325d42938766c4822cb98ebe5849b6f292)

All wrapper functions created by Composer methods now have meaningful `fn.name` values set via `Object.defineProperty`. Format: `type:handlerName`. For example: `derive:getUser`, `guard:isAdmin`, `on:message`. `use()` does NOT rename user functions — they keep their original names in stack traces.

### [cleanErrorStack() strips library frames](https://github.com/gramiojs/composer/commit/07de732)

A new internal `cleanErrorStack()` utility removes GramIO library frames from error stack traces. When your handler throws, the stack trace you see is your code, not the framework internals.

### [MaybeArray now accepts readonly arrays](https://github.com/gramiojs/composer/commit/a9f0320)

`MaybeArray<T>` changed from `T | T[]` to `T | readonly T[]`. If you pass `as const` arrays, they now work correctly without type assertions.

***

## [@gramio/test v0.1.0 — Reactions, Inline Queries & Fluent Scopes](https://github.com/gramiojs/test/compare/v0.0.2...v0.1.0)

The testing library graduates from `0.0.x` to `0.1.0` with a comprehensive API expansion. Your test scenarios can now cover reactions, inline mode, and fluent user/chat scoping.

### [user.react() — test reaction handlers](https://github.com/gramiojs/test/commit/7910262bdef296dd7c4ee9e56a810779f83c033d)

Emit `message_reaction` updates in your tests. Works with `bot.reaction()` handlers:

```ts
const msg = await user.sendMessage("Nice bot!");

// Single emoji
await user.react("👍", msg);

// Multiple emojis
await user.react(["👍", "❤"], msg);

// Simulate changing a reaction
await user.react("❤", msg, { oldReactions: ["👍"] });
```

Use the new `ReactObject` builder for more control:

```ts
await user.react(
    new ReactObject()
        .on(msg)          // attach to message (infers chat)
        .add("👍", "🔥") // new_reaction
        .remove("😢")    // old_reaction
);
```

The `ReactObject.from(otherUser)` method lets you attribute a reaction to a different user than the one calling `.react()`.

### [Automatic reaction state tracking on MessageObject](https://github.com/gramiojs/test/commit/bf55f6a)

`MessageObject` now maintains a `.reactions` Map tracking per-user reactions. When `user.react()` is called, `old_reaction` is automatically computed from in-memory state — you don't need to declare it manually unless you want to override:

```ts
await user.react("👍", msg);  // adds 👍, old_reaction = []
await user.react("❤", msg);  // adds ❤, old_reaction = ["👍"] — auto-computed!
```

### [user.sendInlineQuery() — test inline mode](https://github.com/gramiojs/test/commit/7910262bdef296dd7c4ee9e56a810779f83c033d)

Emit `inline_query` updates. Pass a `ChatObject` to automatically derive `chat_type`:

```ts
const q = await user.sendInlineQuery("search cats");
const q2 = await user.sendInlineQuery("search cats", group); // chat_type: "group"
const q3 = await user.sendInlineQuery("search dogs", { offset: "10" });
```

### [user.chooseInlineResult() — test chosen\_inline\_result](https://github.com/gramiojs/test/commit/7910262bdef296dd7c4ee9e56a810779f83c033d)

```ts
await user.chooseInlineResult("result-1", "search cats");
await user.chooseInlineResult("result-1", "search cats", { inline_message_id: "abc" });
```

### [Fluent scope API — user.in(chat) and user.on(msg)](https://github.com/gramiojs/test/commit/7910262bdef296dd7c4ee9e56a810779f83c033d)

Two new scope classes make tests read like natural user stories:

```ts
// user.in(chat) — bind actions to a specific chat
await user.in(group).sendMessage("Hello");
await user.in(group).sendInlineQuery("cats");
await user.in(group).join();
await user.in(group).leave();

// user.on(msg) — bind actions to a specific message
await user.on(msg).react("👍");
await user.on(msg).click("action:1");

// Chains combine naturally:
await user.in(group).on(msg).react("🔥");
await user.in(group).on(msg).click("choice:A");
```

New exported objects: `ReactObject`, `InlineQueryObject`, `ChosenInlineResultObject`, `UserInChatScope`, `UserOnMessageScope`.

***

## [@gramio/scenes — onInvalidInput for ask()](https://github.com/gramiojs/scenes/commit/52c517c545d2c6457decbc73b25b842411eb8f89)

The `ask()` method now accepts an `onInvalidInput` option — a custom handler that fires when validation fails, instead of just sending the schema's error message:

```ts
const scene = new Scene("registration")
    .ask(
        "age",
        z.coerce.number().min(18),
        "How old are you?",
        {
            onInvalidInput: async (context, error) => {
                await context.send(`❌ ${error.message}\nPlease try again.`);
            }
        }
    );
```

Also in this release: `users_shared` added to the scenes event list, peer dependency updated to `gramio >= 0.5.0`, and `@gramio/storage` bumped to `^2.0.0`.

***

## [@gramio/storages — Typed Storage Keys (v2.0.1)](https://github.com/gramiojs/storages/commit/fc2303f)

The `Storage` interface now uses a generic `Data` type with typed keys across all methods (`get`, `set`, `has`, `delete`). All storage adapters serialize keys via `String()` to maintain backward compatibility.

Version bumps:

* `@gramio/storage` → **2.0.1**
* `@gramio/storage-redis` → **1.0.5**
* `@gramio/storage-cloudflare` → **0.0.2**
* `@gramio/storage-sqlite` → **0.0.2**

### [@gramio/storage-sqlite — Dual Runtime Support](https://github.com/gramiojs/storages/commit/bb966f5)

The SQLite storage adapter now ships with full **Bun and Node.js** support. The `prepublishOnly` pipeline runs a type check, build, and then the test suite against both runtimes before publishing. README updated with per-runtime installation and usage examples.

***

## [@gramio/session v0.2.0 — Lazy Sessions & Modular Architecture](https://github.com/gramiojs/session/commit/8c6605b)

### [Lazy session loading](https://github.com/gramiojs/session/commit/8c6605b)

Sessions are now loaded **only when first accessed** instead of on every incoming update. This can cut database reads by 50–90% for bots where the majority of handlers don't touch session data at all.

```ts
bot.use(session({
    storage: redisStorage,
    lazy: true,
}));
```

With `lazy: true`, the storage `get` call is deferred until the first read of `ctx.session`. The write-back at the end of the middleware chain is unchanged.

### [Modular architecture refactor](https://github.com/gramiojs/session/commit/8c6605b)

The single-file implementation has been split into a `src/lib/` module structure. No public API changes — this is an internal reorganization for maintainability and test isolation.

### [Comprehensive test suite](https://github.com/gramiojs/session/commit/bb9b30a)

A full test suite now covers session read/write, clearing via `ctx.session = null`, custom session keys, and lazy loading behavior.

---

---
url: 'https://gramio.dev/api/gramio.md'
---
[GramIO API Reference](../../index.md) / gramio/dist

# gramio/dist

## Namespaces

| Namespace | Description |
| ------ | ------ |
| [Hooks](namespaces/Hooks/index.md) | Namespace with GramIO hooks types |
| [This module contains \[Objects\](https://core.telegram.org/bots/api#available-types) with the \`Telegram\` prefix](namespaces/This-module-contains-[Objects]\(https:/core.telegram.org/bots/api#available-types\)-with-the-`Telegram`-prefix/index.md) | - |
| [This module contains params for \[methods\](https://core.telegram.org/bots/api#available-methods) with the \`Params\` postfix](namespaces/This-module-contains-params-for-[methods]\(https:/core.telegram.org/bots/api#available-methods\)-with-the-`Params`-postfix/index.md) | - |

## Classes

| Class | Description |
| ------ | ------ |
| [Bot](classes/Bot.md) | Bot instance |
| [FormattableString](classes/FormattableString.md) | Class-helper for work with formattable [entities](https://core.telegram.org/bots/api#messageentity) |
| [Plugin](classes/Plugin.md) | `Plugin` is an object from which you can extends in Bot instance and adopt types |
| [TelegramError](classes/TelegramError.md) | Represent [TelegramAPIResponseError](interfaces/TelegramAPIResponseError.md) and thrown in API calls |
| [Updates](classes/Updates.md) | - |

## Interfaces

| Interface | Description |
| ------ | ------ |
| [AddStickerToSetParams](interfaces/AddStickerToSetParams.md) | Params object for [addStickerToSet](interfaces/APIMethods.md#addstickertoset) method |
| [AnswerCallbackQueryParams](interfaces/AnswerCallbackQueryParams.md) | Params object for [answerCallbackQuery](interfaces/APIMethods.md#answercallbackquery) method |
| [AnswerInlineQueryParams](interfaces/AnswerInlineQueryParams.md) | Params object for [answerInlineQuery](interfaces/APIMethods.md#answerinlinequery) method |
| [AnswerPreCheckoutQueryParams](interfaces/AnswerPreCheckoutQueryParams.md) | Params object for [answerPreCheckoutQuery](interfaces/APIMethods.md#answerprecheckoutquery) method |
| [AnswerShippingQueryParams](interfaces/AnswerShippingQueryParams.md) | Params object for [answerShippingQuery](interfaces/APIMethods.md#answershippingquery) method |
| [AnswerWebAppQueryParams](interfaces/AnswerWebAppQueryParams.md) | Params object for [answerWebAppQuery](interfaces/APIMethods.md#answerwebappquery) method |
| [APIMethods](interfaces/APIMethods.md) | This object is a map of [API methods](https://core.telegram.org/bots/api#available-methods) types (functions map with input/output) |
| [ApproveChatJoinRequestParams](interfaces/ApproveChatJoinRequestParams.md) | Params object for [approveChatJoinRequest](interfaces/APIMethods.md#approvechatjoinrequest) method |
| [ApproveSuggestedPostParams](interfaces/ApproveSuggestedPostParams.md) | Params object for [approveSuggestedPost](interfaces/APIMethods.md#approvesuggestedpost) method |
| [BanChatMemberParams](interfaces/BanChatMemberParams.md) | Params object for [banChatMember](interfaces/APIMethods.md#banchatmember) method |
| [BanChatSenderChatParams](interfaces/BanChatSenderChatParams.md) | Params object for [banChatSenderChat](interfaces/APIMethods.md#banchatsenderchat) method |
| [BotOptions](interfaces/BotOptions.md) | Bot options that you can provide to [Bot](classes/Bot.md) constructor |
| [BotStartOptions](interfaces/BotStartOptions.md) | - |
| [CloseForumTopicParams](interfaces/CloseForumTopicParams.md) | Params object for [closeForumTopic](interfaces/APIMethods.md#closeforumtopic) method |
| [CloseGeneralForumTopicParams](interfaces/CloseGeneralForumTopicParams.md) | Params object for [closeGeneralForumTopic](interfaces/APIMethods.md#closegeneralforumtopic) method |
| [ConvertGiftToStarsParams](interfaces/ConvertGiftToStarsParams.md) | Params object for [convertGiftToStars](interfaces/APIMethods.md#convertgifttostars) method |
| [CopyMessageParams](interfaces/CopyMessageParams.md) | Params object for [copyMessage](interfaces/APIMethods.md#copymessage) method |
| [CopyMessagesParams](interfaces/CopyMessagesParams.md) | Params object for [copyMessages](interfaces/APIMethods.md#copymessages) method |
| [CreateChatInviteLinkParams](interfaces/CreateChatInviteLinkParams.md) | Params object for [createChatInviteLink](interfaces/APIMethods.md#createchatinvitelink) method |
| [CreateChatSubscriptionInviteLinkParams](interfaces/CreateChatSubscriptionInviteLinkParams.md) | Params object for [createChatSubscriptionInviteLink](interfaces/APIMethods.md#createchatsubscriptioninvitelink) method |
| [CreateForumTopicParams](interfaces/CreateForumTopicParams.md) | Params object for [createForumTopic](interfaces/APIMethods.md#createforumtopic) method |
| [CreateInvoiceLinkParams](interfaces/CreateInvoiceLinkParams.md) | Params object for [createInvoiceLink](interfaces/APIMethods.md#createinvoicelink) method |
| [CreateNewStickerSetParams](interfaces/CreateNewStickerSetParams.md) | Params object for [createNewStickerSet](interfaces/APIMethods.md#createnewstickerset) method |
| [DeclineChatJoinRequestParams](interfaces/DeclineChatJoinRequestParams.md) | Params object for [declineChatJoinRequest](interfaces/APIMethods.md#declinechatjoinrequest) method |
| [DeclineSuggestedPostParams](interfaces/DeclineSuggestedPostParams.md) | Params object for [declineSuggestedPost](interfaces/APIMethods.md#declinesuggestedpost) method |
| [DeleteBusinessMessagesParams](interfaces/DeleteBusinessMessagesParams.md) | Params object for [deleteBusinessMessages](interfaces/APIMethods.md#deletebusinessmessages) method |
| [DeleteChatPhotoParams](interfaces/DeleteChatPhotoParams.md) | Params object for [deleteChatPhoto](interfaces/APIMethods.md#deletechatphoto) method |
| [DeleteChatStickerSetParams](interfaces/DeleteChatStickerSetParams.md) | Params object for [deleteChatStickerSet](interfaces/APIMethods.md#deletechatstickerset) method |
| [DeleteForumTopicParams](interfaces/DeleteForumTopicParams.md) | Params object for [deleteForumTopic](interfaces/APIMethods.md#deleteforumtopic) method |
| [DeleteMessageParams](interfaces/DeleteMessageParams.md) | Params object for [deleteMessage](interfaces/APIMethods.md#deletemessage) method |
| [DeleteMessagesParams](interfaces/DeleteMessagesParams.md) | Params object for [deleteMessages](interfaces/APIMethods.md#deletemessages) method |
| [DeleteMyCommandsParams](interfaces/DeleteMyCommandsParams.md) | Params object for [deleteMyCommands](interfaces/APIMethods.md#deletemycommands) method |
| [DeleteStickerFromSetParams](interfaces/DeleteStickerFromSetParams.md) | Params object for [deleteStickerFromSet](interfaces/APIMethods.md#deletestickerfromset) method |
| [DeleteStickerSetParams](interfaces/DeleteStickerSetParams.md) | Params object for [deleteStickerSet](interfaces/APIMethods.md#deletestickerset) method |
| [DeleteStoryParams](interfaces/DeleteStoryParams.md) | Params object for [deleteStory](interfaces/APIMethods.md#deletestory) method |
| [DeleteWebhookParams](interfaces/DeleteWebhookParams.md) | Params object for [deleteWebhook](interfaces/APIMethods.md#deletewebhook) method |
| [EditChatInviteLinkParams](interfaces/EditChatInviteLinkParams.md) | Params object for [editChatInviteLink](interfaces/APIMethods.md#editchatinvitelink) method |
| [EditChatSubscriptionInviteLinkParams](interfaces/EditChatSubscriptionInviteLinkParams.md) | Params object for [editChatSubscriptionInviteLink](interfaces/APIMethods.md#editchatsubscriptioninvitelink) method |
| [EditForumTopicParams](interfaces/EditForumTopicParams.md) | Params object for [editForumTopic](interfaces/APIMethods.md#editforumtopic) method |
| [EditGeneralForumTopicParams](interfaces/EditGeneralForumTopicParams.md) | Params object for [editGeneralForumTopic](interfaces/APIMethods.md#editgeneralforumtopic) method |
| [EditMessageCaptionParams](interfaces/EditMessageCaptionParams.md) | Params object for [editMessageCaption](interfaces/APIMethods.md#editmessagecaption) method |
| [EditMessageChecklistParams](interfaces/EditMessageChecklistParams.md) | Params object for [editMessageChecklist](interfaces/APIMethods.md#editmessagechecklist) method |
| [EditMessageLiveLocationParams](interfaces/EditMessageLiveLocationParams.md) | Params object for [editMessageLiveLocation](interfaces/APIMethods.md#editmessagelivelocation) method |
| [EditMessageMediaParams](interfaces/EditMessageMediaParams.md) | Params object for [editMessageMedia](interfaces/APIMethods.md#editmessagemedia) method |
| [EditMessageReplyMarkupParams](interfaces/EditMessageReplyMarkupParams.md) | Params object for [editMessageReplyMarkup](interfaces/APIMethods.md#editmessagereplymarkup) method |
| [EditMessageTextParams](interfaces/EditMessageTextParams.md) | Params object for [editMessageText](interfaces/APIMethods.md#editmessagetext) method |
| [EditStoryParams](interfaces/EditStoryParams.md) | Params object for [editStory](interfaces/APIMethods.md#editstory) method |
| [EditUserStarSubscriptionParams](interfaces/EditUserStarSubscriptionParams.md) | Params object for [editUserStarSubscription](interfaces/APIMethods.md#edituserstarsubscription) method |
| [ExportChatInviteLinkParams](interfaces/ExportChatInviteLinkParams.md) | Params object for [exportChatInviteLink](interfaces/APIMethods.md#exportchatinvitelink) method |
| [ForwardMessageParams](interfaces/ForwardMessageParams.md) | Params object for [forwardMessage](interfaces/APIMethods.md#forwardmessage) method |
| [ForwardMessagesParams](interfaces/ForwardMessagesParams.md) | Params object for [forwardMessages](interfaces/APIMethods.md#forwardmessages) method |
| [GetBusinessAccountGiftsParams](interfaces/GetBusinessAccountGiftsParams.md) | Params object for [getBusinessAccountGifts](interfaces/APIMethods.md#getbusinessaccountgifts) method |
| [GetBusinessAccountStarBalanceParams](interfaces/GetBusinessAccountStarBalanceParams.md) | Params object for [getBusinessAccountStarBalance](interfaces/APIMethods.md#getbusinessaccountstarbalance) method |
| [GetBusinessConnectionParams](interfaces/GetBusinessConnectionParams.md) | Params object for [getBusinessConnection](interfaces/APIMethods.md#getbusinessconnection) method |
| [GetChatAdministratorsParams](interfaces/GetChatAdministratorsParams.md) | Params object for [getChatAdministrators](interfaces/APIMethods.md#getchatadministrators) method |
| [GetChatGiftsParams](interfaces/GetChatGiftsParams.md) | Params object for [getChatGifts](interfaces/APIMethods.md#getchatgifts) method |
| [GetChatMemberCountParams](interfaces/GetChatMemberCountParams.md) | Params object for [getChatMemberCount](interfaces/APIMethods.md#getchatmembercount) method |
| [GetChatMemberParams](interfaces/GetChatMemberParams.md) | Params object for [getChatMember](interfaces/APIMethods.md#getchatmember) method |
| [GetChatMenuButtonParams](interfaces/GetChatMenuButtonParams.md) | Params object for [getChatMenuButton](interfaces/APIMethods.md#getchatmenubutton) method |
| [GetChatParams](interfaces/GetChatParams.md) | Params object for [getChat](interfaces/APIMethods.md#getchat) method |
| [GetCustomEmojiStickersParams](interfaces/GetCustomEmojiStickersParams.md) | Params object for [getCustomEmojiStickers](interfaces/APIMethods.md#getcustomemojistickers) method |
| [GetFileParams](interfaces/GetFileParams.md) | Params object for [getFile](interfaces/APIMethods.md#getfile) method |
| [GetGameHighScoresParams](interfaces/GetGameHighScoresParams.md) | Params object for [getGameHighScores](interfaces/APIMethods.md#getgamehighscores) method |
| [GetMyCommandsParams](interfaces/GetMyCommandsParams.md) | Params object for [getMyCommands](interfaces/APIMethods.md#getmycommands) method |
| [GetMyDefaultAdministratorRightsParams](interfaces/GetMyDefaultAdministratorRightsParams.md) | Params object for [getMyDefaultAdministratorRights](interfaces/APIMethods.md#getmydefaultadministratorrights) method |
| [GetMyDescriptionParams](interfaces/GetMyDescriptionParams.md) | Params object for [getMyDescription](interfaces/APIMethods.md#getmydescription) method |
| [GetMyNameParams](interfaces/GetMyNameParams.md) | Params object for [getMyName](interfaces/APIMethods.md#getmyname) method |
| [GetMyShortDescriptionParams](interfaces/GetMyShortDescriptionParams.md) | Params object for [getMyShortDescription](interfaces/APIMethods.md#getmyshortdescription) method |
| [GetStarTransactionsParams](interfaces/GetStarTransactionsParams.md) | Params object for [getStarTransactions](interfaces/APIMethods.md#getstartransactions) method |
| [GetStickerSetParams](interfaces/GetStickerSetParams.md) | Params object for [getStickerSet](interfaces/APIMethods.md#getstickerset) method |
| [GetUpdatesParams](interfaces/GetUpdatesParams.md) | Params object for [getUpdates](interfaces/APIMethods.md#getupdates) method |
| [GetUserChatBoostsParams](interfaces/GetUserChatBoostsParams.md) | Params object for [getUserChatBoosts](interfaces/APIMethods.md#getuserchatboosts) method |
| [GetUserGiftsParams](interfaces/GetUserGiftsParams.md) | Params object for [getUserGifts](interfaces/APIMethods.md#getusergifts) method |
| [GetUserProfileAudiosParams](interfaces/GetUserProfileAudiosParams.md) | Params object for [getUserProfileAudios](interfaces/APIMethods.md#getuserprofileaudios) method |
| [GetUserProfilePhotosParams](interfaces/GetUserProfilePhotosParams.md) | Params object for [getUserProfilePhotos](interfaces/APIMethods.md#getuserprofilephotos) method |
| [GiftPremiumSubscriptionParams](interfaces/GiftPremiumSubscriptionParams.md) | Params object for [giftPremiumSubscription](interfaces/APIMethods.md#giftpremiumsubscription) method |
| [HideGeneralForumTopicParams](interfaces/HideGeneralForumTopicParams.md) | Params object for [hideGeneralForumTopic](interfaces/APIMethods.md#hidegeneralforumtopic) method |
| [LeaveChatParams](interfaces/LeaveChatParams.md) | Params object for [leaveChat](interfaces/APIMethods.md#leavechat) method |
| [PinChatMessageParams](interfaces/PinChatMessageParams.md) | Params object for [pinChatMessage](interfaces/APIMethods.md#pinchatmessage) method |
| [PollingStartOptions](interfaces/PollingStartOptions.md) | - |
| [PostStoryParams](interfaces/PostStoryParams.md) | Params object for [postStory](interfaces/APIMethods.md#poststory) method |
| [PromoteChatMemberParams](interfaces/PromoteChatMemberParams.md) | Params object for [promoteChatMember](interfaces/APIMethods.md#promotechatmember) method |
| [ReadBusinessMessageParams](interfaces/ReadBusinessMessageParams.md) | Params object for [readBusinessMessage](interfaces/APIMethods.md#readbusinessmessage) method |
| [RefundStarPaymentParams](interfaces/RefundStarPaymentParams.md) | Params object for [refundStarPayment](interfaces/APIMethods.md#refundstarpayment) method |
| [RemoveBusinessAccountProfilePhotoParams](interfaces/RemoveBusinessAccountProfilePhotoParams.md) | Params object for [removeBusinessAccountProfilePhoto](interfaces/APIMethods.md#removebusinessaccountprofilephoto) method |
| [RemoveChatVerificationParams](interfaces/RemoveChatVerificationParams.md) | Params object for [removeChatVerification](interfaces/APIMethods.md#removechatverification) method |
| [RemoveUserVerificationParams](interfaces/RemoveUserVerificationParams.md) | Params object for [removeUserVerification](interfaces/APIMethods.md#removeuserverification) method |
| [ReopenForumTopicParams](interfaces/ReopenForumTopicParams.md) | Params object for [reopenForumTopic](interfaces/APIMethods.md#reopenforumtopic) method |
| [ReopenGeneralForumTopicParams](interfaces/ReopenGeneralForumTopicParams.md) | Params object for [reopenGeneralForumTopic](interfaces/APIMethods.md#reopengeneralforumtopic) method |
| [ReplaceStickerInSetParams](interfaces/ReplaceStickerInSetParams.md) | Params object for [replaceStickerInSet](interfaces/APIMethods.md#replacestickerinset) method |
| [RepostStoryParams](interfaces/RepostStoryParams.md) | Params object for [repostStory](interfaces/APIMethods.md#repoststory) method |
| [RestrictChatMemberParams](interfaces/RestrictChatMemberParams.md) | Params object for [restrictChatMember](interfaces/APIMethods.md#restrictchatmember) method |
| [RevokeChatInviteLinkParams](interfaces/RevokeChatInviteLinkParams.md) | Params object for [revokeChatInviteLink](interfaces/APIMethods.md#revokechatinvitelink) method |
| [SavePreparedInlineMessageParams](interfaces/SavePreparedInlineMessageParams.md) | Params object for [savePreparedInlineMessage](interfaces/APIMethods.md#savepreparedinlinemessage) method |
| [SendAnimationParams](interfaces/SendAnimationParams.md) | Params object for [sendAnimation](interfaces/APIMethods.md#sendanimation) method |
| [SendAudioParams](interfaces/SendAudioParams.md) | Params object for [sendAudio](interfaces/APIMethods.md#sendaudio) method |
| [SendChatActionParams](interfaces/SendChatActionParams.md) | Params object for [sendChatAction](interfaces/APIMethods.md#sendchataction) method |
| [SendChecklistParams](interfaces/SendChecklistParams.md) | Params object for [sendChecklist](interfaces/APIMethods.md#sendchecklist) method |
| [SendContactParams](interfaces/SendContactParams.md) | Params object for [sendContact](interfaces/APIMethods.md#sendcontact) method |
| [SendDiceParams](interfaces/SendDiceParams.md) | Params object for [sendDice](interfaces/APIMethods.md#senddice) method |
| [SendDocumentParams](interfaces/SendDocumentParams.md) | Params object for [sendDocument](interfaces/APIMethods.md#senddocument) method |
| [SendGameParams](interfaces/SendGameParams.md) | Params object for [sendGame](interfaces/APIMethods.md#sendgame) method |
| [SendGiftParams](interfaces/SendGiftParams.md) | Params object for [sendGift](interfaces/APIMethods.md#sendgift) method |
| [SendInvoiceParams](interfaces/SendInvoiceParams.md) | Params object for [sendInvoice](interfaces/APIMethods.md#sendinvoice) method |
| [SendLocationParams](interfaces/SendLocationParams.md) | Params object for [sendLocation](interfaces/APIMethods.md#sendlocation) method |
| [SendMediaGroupParams](interfaces/SendMediaGroupParams.md) | Params object for [sendMediaGroup](interfaces/APIMethods.md#sendmediagroup) method |
| [SendMessageDraftParams](interfaces/SendMessageDraftParams.md) | Params object for [sendMessageDraft](interfaces/APIMethods.md#sendmessagedraft) method |
| [SendMessageParams](interfaces/SendMessageParams.md) | Params object for [sendMessage](interfaces/APIMethods.md#sendmessage) method |
| [SendPaidMediaParams](interfaces/SendPaidMediaParams.md) | Params object for [sendPaidMedia](interfaces/APIMethods.md#sendpaidmedia) method |
| [SendPhotoParams](interfaces/SendPhotoParams.md) | Params object for [sendPhoto](interfaces/APIMethods.md#sendphoto) method |
| [SendPollParams](interfaces/SendPollParams.md) | Params object for [sendPoll](interfaces/APIMethods.md#sendpoll) method |
| [SendStickerParams](interfaces/SendStickerParams.md) | Params object for [sendSticker](interfaces/APIMethods.md#sendsticker) method |
| [SendVenueParams](interfaces/SendVenueParams.md) | Params object for [sendVenue](interfaces/APIMethods.md#sendvenue) method |
| [SendVideoNoteParams](interfaces/SendVideoNoteParams.md) | Params object for [sendVideoNote](interfaces/APIMethods.md#sendvideonote) method |
| [SendVideoParams](interfaces/SendVideoParams.md) | Params object for [sendVideo](interfaces/APIMethods.md#sendvideo) method |
| [SendVoiceParams](interfaces/SendVoiceParams.md) | Params object for [sendVoice](interfaces/APIMethods.md#sendvoice) method |
| [SetBusinessAccountBioParams](interfaces/SetBusinessAccountBioParams.md) | Params object for [setBusinessAccountBio](interfaces/APIMethods.md#setbusinessaccountbio) method |
| [SetBusinessAccountGiftSettingsParams](interfaces/SetBusinessAccountGiftSettingsParams.md) | Params object for [setBusinessAccountGiftSettings](interfaces/APIMethods.md#setbusinessaccountgiftsettings) method |
| [SetBusinessAccountNameParams](interfaces/SetBusinessAccountNameParams.md) | Params object for [setBusinessAccountName](interfaces/APIMethods.md#setbusinessaccountname) method |
| [SetBusinessAccountProfilePhotoParams](interfaces/SetBusinessAccountProfilePhotoParams.md) | Params object for [setBusinessAccountProfilePhoto](interfaces/APIMethods.md#setbusinessaccountprofilephoto) method |
| [SetBusinessAccountUsernameParams](interfaces/SetBusinessAccountUsernameParams.md) | Params object for [setBusinessAccountUsername](interfaces/APIMethods.md#setbusinessaccountusername) method |
| [SetChatAdministratorCustomTitleParams](interfaces/SetChatAdministratorCustomTitleParams.md) | Params object for [setChatAdministratorCustomTitle](interfaces/APIMethods.md#setchatadministratorcustomtitle) method |
| [SetChatDescriptionParams](interfaces/SetChatDescriptionParams.md) | Params object for [setChatDescription](interfaces/APIMethods.md#setchatdescription) method |
| [SetChatMemberTagParams](interfaces/SetChatMemberTagParams.md) | Params object for [setChatMemberTag](interfaces/APIMethods.md#setchatmembertag) method |
| [SetChatMenuButtonParams](interfaces/SetChatMenuButtonParams.md) | Params object for [setChatMenuButton](interfaces/APIMethods.md#setchatmenubutton) method |
| [SetChatPermissionsParams](interfaces/SetChatPermissionsParams.md) | Params object for [setChatPermissions](interfaces/APIMethods.md#setchatpermissions) method |
| [SetChatPhotoParams](interfaces/SetChatPhotoParams.md) | Params object for [setChatPhoto](interfaces/APIMethods.md#setchatphoto) method |
| [SetChatStickerSetParams](interfaces/SetChatStickerSetParams.md) | Params object for [setChatStickerSet](interfaces/APIMethods.md#setchatstickerset) method |
| [SetChatTitleParams](interfaces/SetChatTitleParams.md) | Params object for [setChatTitle](interfaces/APIMethods.md#setchattitle) method |
| [SetCustomEmojiStickerSetThumbnailParams](interfaces/SetCustomEmojiStickerSetThumbnailParams.md) | Params object for [setCustomEmojiStickerSetThumbnail](interfaces/APIMethods.md#setcustomemojistickersetthumbnail) method |
| [SetGameScoreParams](interfaces/SetGameScoreParams.md) | Params object for [setGameScore](interfaces/APIMethods.md#setgamescore) method |
| [SetMessageReactionParams](interfaces/SetMessageReactionParams.md) | Params object for [setMessageReaction](interfaces/APIMethods.md#setmessagereaction) method |
| [SetMyCommandsParams](interfaces/SetMyCommandsParams.md) | Params object for [setMyCommands](interfaces/APIMethods.md#setmycommands) method |
| [SetMyDefaultAdministratorRightsParams](interfaces/SetMyDefaultAdministratorRightsParams.md) | Params object for [setMyDefaultAdministratorRights](interfaces/APIMethods.md#setmydefaultadministratorrights) method |
| [SetMyDescriptionParams](interfaces/SetMyDescriptionParams.md) | Params object for [setMyDescription](interfaces/APIMethods.md#setmydescription) method |
| [SetMyNameParams](interfaces/SetMyNameParams.md) | Params object for [setMyName](interfaces/APIMethods.md#setmyname) method |
| [SetMyProfilePhotoParams](interfaces/SetMyProfilePhotoParams.md) | Params object for [setMyProfilePhoto](interfaces/APIMethods.md#setmyprofilephoto) method |
| [SetMyShortDescriptionParams](interfaces/SetMyShortDescriptionParams.md) | Params object for [setMyShortDescription](interfaces/APIMethods.md#setmyshortdescription) method |
| [SetPassportDataErrorsParams](interfaces/SetPassportDataErrorsParams.md) | Params object for [setPassportDataErrors](interfaces/APIMethods.md#setpassportdataerrors) method |
| [SetStickerEmojiListParams](interfaces/SetStickerEmojiListParams.md) | Params object for [setStickerEmojiList](interfaces/APIMethods.md#setstickeremojilist) method |
| [SetStickerKeywordsParams](interfaces/SetStickerKeywordsParams.md) | Params object for [setStickerKeywords](interfaces/APIMethods.md#setstickerkeywords) method |
| [SetStickerMaskPositionParams](interfaces/SetStickerMaskPositionParams.md) | Params object for [setStickerMaskPosition](interfaces/APIMethods.md#setstickermaskposition) method |
| [SetStickerPositionInSetParams](interfaces/SetStickerPositionInSetParams.md) | Params object for [setStickerPositionInSet](interfaces/APIMethods.md#setstickerpositioninset) method |
| [SetStickerSetThumbnailParams](interfaces/SetStickerSetThumbnailParams.md) | Params object for [setStickerSetThumbnail](interfaces/APIMethods.md#setstickersetthumbnail) method |
| [SetStickerSetTitleParams](interfaces/SetStickerSetTitleParams.md) | Params object for [setStickerSetTitle](interfaces/APIMethods.md#setstickersettitle) method |
| [SetUserEmojiStatusParams](interfaces/SetUserEmojiStatusParams.md) | Params object for [setUserEmojiStatus](interfaces/APIMethods.md#setuseremojistatus) method |
| [SetWebhookParams](interfaces/SetWebhookParams.md) | Params object for [setWebhook](interfaces/APIMethods.md#setwebhook) method |
| [StopMessageLiveLocationParams](interfaces/StopMessageLiveLocationParams.md) | Params object for [stopMessageLiveLocation](interfaces/APIMethods.md#stopmessagelivelocation) method |
| [StopPollParams](interfaces/StopPollParams.md) | Params object for [stopPoll](interfaces/APIMethods.md#stoppoll) method |
| [Suppress](interfaces/Suppress.md) | Interface for add `suppress` param to params |
| [TelegramAcceptedGiftTypes](interfaces/TelegramAcceptedGiftTypes.md) | This object describes the types of gifts that can be gifted to a user or a chat. |
| [TelegramAffiliateInfo](interfaces/TelegramAffiliateInfo.md) | Contains information about the affiliate that received a commission via this transaction. |
| [TelegramAnimation](interfaces/TelegramAnimation.md) | This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound). |
| [TelegramAPIResponseError](interfaces/TelegramAPIResponseError.md) | In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. |
| [TelegramAPIResponseOk](interfaces/TelegramAPIResponseOk.md) | If 'ok' equals True, the request was successful and the result of the query can be found in the 'result' field. |
| [TelegramAudio](interfaces/TelegramAudio.md) | This object represents an audio file to be treated as music by the Telegram clients. |
| [TelegramBackgroundFillFreeformGradient](interfaces/TelegramBackgroundFillFreeformGradient.md) | The background is a freeform gradient that rotates after every message in the chat. |
| [TelegramBackgroundFillGradient](interfaces/TelegramBackgroundFillGradient.md) | The background is a gradient fill. |
| [TelegramBackgroundFillSolid](interfaces/TelegramBackgroundFillSolid.md) | The background is filled using the selected color. |
| [TelegramBackgroundTypeChatTheme](interfaces/TelegramBackgroundTypeChatTheme.md) | The background is taken directly from a built-in chat theme. |
| [TelegramBackgroundTypeFill](interfaces/TelegramBackgroundTypeFill.md) | The background is automatically filled based on the selected colors. |
| [TelegramBackgroundTypePattern](interfaces/TelegramBackgroundTypePattern.md) | The background is a .PNG or .TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user. |
| [TelegramBackgroundTypeWallpaper](interfaces/TelegramBackgroundTypeWallpaper.md) | The background is a wallpaper in the JPEG format. |
| [TelegramBirthdate](interfaces/TelegramBirthdate.md) | Describes the birthdate of a user. |
| [TelegramBotCommand](interfaces/TelegramBotCommand.md) | This object represents a bot command. |
| [TelegramBotCommandScopeAllChatAdministrators](interfaces/TelegramBotCommandScopeAllChatAdministrators.md) | Represents the [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all group and supergroup chat administrators. |
| [TelegramBotCommandScopeAllGroupChats](interfaces/TelegramBotCommandScopeAllGroupChats.md) | Represents the [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all group and supergroup chats. |
| [TelegramBotCommandScopeAllPrivateChats](interfaces/TelegramBotCommandScopeAllPrivateChats.md) | Represents the [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all private chats. |
| [TelegramBotCommandScopeChat](interfaces/TelegramBotCommandScopeChat.md) | Represents the [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering a specific chat. |
| [TelegramBotCommandScopeChatAdministrators](interfaces/TelegramBotCommandScopeChatAdministrators.md) | Represents the [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all administrators of a specific group or supergroup chat. |
| [TelegramBotCommandScopeChatMember](interfaces/TelegramBotCommandScopeChatMember.md) | Represents the [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering a specific member of a group or supergroup chat. |
| [TelegramBotCommandScopeDefault](interfaces/TelegramBotCommandScopeDefault.md) | Represents the default [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands. Default commands are used if no commands with a [narrower scope](https://core.telegram.org/bots/api#determining-list-of-commands) are specified for the user. |
| [TelegramBotDescription](interfaces/TelegramBotDescription.md) | This object represents the bot's description. |
| [TelegramBotName](interfaces/TelegramBotName.md) | This object represents the bot's name. |
| [TelegramBotShortDescription](interfaces/TelegramBotShortDescription.md) | This object represents the bot's short description. |
| [TelegramBusinessBotRights](interfaces/TelegramBusinessBotRights.md) | Represents the rights of a business bot. |
| [TelegramBusinessConnection](interfaces/TelegramBusinessConnection.md) | Describes the connection of the bot with a business account. |
| [TelegramBusinessIntro](interfaces/TelegramBusinessIntro.md) | Contains information about the start page settings of a Telegram Business account. |
| [TelegramBusinessLocation](interfaces/TelegramBusinessLocation.md) | Contains information about the location of a Telegram Business account. |
| [TelegramBusinessMessagesDeleted](interfaces/TelegramBusinessMessagesDeleted.md) | This object is received when messages are deleted from a connected business account. |
| [TelegramBusinessOpeningHours](interfaces/TelegramBusinessOpeningHours.md) | Describes the opening hours of a business. |
| [TelegramBusinessOpeningHoursInterval](interfaces/TelegramBusinessOpeningHoursInterval.md) | Describes an interval of time during which a business is open. |
| [TelegramCallbackGame](interfaces/TelegramCallbackGame.md) | A placeholder, currently holds no information. Use [BotFather](https://t.me/botfather) to set up your game. |
| [TelegramCallbackQuery](interfaces/TelegramCallbackQuery.md) | This object represents an incoming callback query from a callback button in an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards). If the button that originated the query was attached to a message sent by the bot, the field *message* will be present. If the button was attached to a message sent via the bot (in [inline mode](https://core.telegram.org/bots/api#inline-mode)), the field *inline\_message\_id* will be present. Exactly one of the fields *data* or *game\_short\_name* will be present. |
| [TelegramChat](interfaces/TelegramChat.md) | This object represents a chat. |
| [TelegramChatAdministratorRights](interfaces/TelegramChatAdministratorRights.md) | Represents the rights of an administrator in a chat. |
| [TelegramChatBackground](interfaces/TelegramChatBackground.md) | This object represents a chat background. |
| [TelegramChatBoost](interfaces/TelegramChatBoost.md) | This object contains information about a chat boost. |
| [TelegramChatBoostAdded](interfaces/TelegramChatBoostAdded.md) | This object represents a service message about a user boosting a chat. |
| [TelegramChatBoostRemoved](interfaces/TelegramChatBoostRemoved.md) | This object represents a boost removed from a chat. |
| [TelegramChatBoostSourceGiftCode](interfaces/TelegramChatBoostSourceGiftCode.md) | The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription. |
| [TelegramChatBoostSourceGiveaway](interfaces/TelegramChatBoostSourceGiveaway.md) | The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and *prize\_star\_count* / 500 times for one year for Telegram Star giveaways. |
| [TelegramChatBoostSourcePremium](interfaces/TelegramChatBoostSourcePremium.md) | The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user. |
| [TelegramChatBoostUpdated](interfaces/TelegramChatBoostUpdated.md) | This object represents a boost added to a chat or changed. |
| [TelegramChatFullInfo](interfaces/TelegramChatFullInfo.md) | This object contains full information about a chat. |
| [TelegramChatInviteLink](interfaces/TelegramChatInviteLink.md) | Represents an invite link for a chat. |
| [TelegramChatJoinRequest](interfaces/TelegramChatJoinRequest.md) | Represents a join request sent to a chat. |
| [TelegramChatLocation](interfaces/TelegramChatLocation.md) | Represents a location to which a chat is connected. |
| [TelegramChatMemberAdministrator](interfaces/TelegramChatMemberAdministrator.md) | Represents a [chat member](https://core.telegram.org/bots/api#chatmember) that has some additional privileges. |
| [TelegramChatMemberBanned](interfaces/TelegramChatMemberBanned.md) | Represents a [chat member](https://core.telegram.org/bots/api#chatmember) that was banned in the chat and can't return to the chat or view chat messages. |
| [TelegramChatMemberLeft](interfaces/TelegramChatMemberLeft.md) | Represents a [chat member](https://core.telegram.org/bots/api#chatmember) that isn't currently a member of the chat, but may join it themselves. |
| [TelegramChatMemberMember](interfaces/TelegramChatMemberMember.md) | Represents a [chat member](https://core.telegram.org/bots/api#chatmember) that has no additional privileges or restrictions. |
| [TelegramChatMemberOwner](interfaces/TelegramChatMemberOwner.md) | Represents a [chat member](https://core.telegram.org/bots/api#chatmember) that owns the chat and has all administrator privileges. |
| [TelegramChatMemberRestricted](interfaces/TelegramChatMemberRestricted.md) | Represents a [chat member](https://core.telegram.org/bots/api#chatmember) that is under certain restrictions in the chat. Supergroups only. |
| [TelegramChatMemberUpdated](interfaces/TelegramChatMemberUpdated.md) | This object represents changes in the status of a chat member. |
| [TelegramChatOwnerChanged](interfaces/TelegramChatOwnerChanged.md) | Describes a service message about an ownership change in the chat. |
| [TelegramChatOwnerLeft](interfaces/TelegramChatOwnerLeft.md) | Describes a service message about the chat owner leaving the chat. |
| [TelegramChatPermissions](interfaces/TelegramChatPermissions.md) | Describes actions that a non-administrator user is allowed to take in a chat. |
| [TelegramChatPhoto](interfaces/TelegramChatPhoto.md) | This object represents a chat photo. |
| [TelegramChatShared](interfaces/TelegramChatShared.md) | This object contains information about a chat that was shared with the bot using a [KeyboardButtonRequestChat](https://core.telegram.org/bots/api#keyboardbuttonrequestchat) button. |
| [TelegramChecklist](interfaces/TelegramChecklist.md) | Describes a checklist. |
| [TelegramChecklistTask](interfaces/TelegramChecklistTask.md) | Describes a task in a checklist. |
| [TelegramChecklistTasksAdded](interfaces/TelegramChecklistTasksAdded.md) | Describes a service message about tasks added to a checklist. |
| [TelegramChecklistTasksDone](interfaces/TelegramChecklistTasksDone.md) | Describes a service message about checklist tasks marked as done or not done. |
| [TelegramChosenInlineResult](interfaces/TelegramChosenInlineResult.md) | Represents a [result](https://core.telegram.org/bots/api#inlinequeryresult) of an inline query that was chosen by the user and sent to their chat partner. |
| [TelegramContact](interfaces/TelegramContact.md) | This object represents a phone contact. |
| [TelegramCopyTextButton](interfaces/TelegramCopyTextButton.md) | This object represents an inline keyboard button that copies specified text to the clipboard. |
| [TelegramDice](interfaces/TelegramDice.md) | This object represents an animated emoji that displays a random value. |
| [TelegramDirectMessagePriceChanged](interfaces/TelegramDirectMessagePriceChanged.md) | Describes a service message about a change in the price of direct messages sent to a channel chat. |
| [TelegramDirectMessagesTopic](interfaces/TelegramDirectMessagesTopic.md) | Describes a topic of a direct messages chat. |
| [TelegramDocument](interfaces/TelegramDocument.md) | This object represents a general file (as opposed to [photos](https://core.telegram.org/bots/api#photosize), [voice messages](https://core.telegram.org/bots/api#voice) and [audio files](https://core.telegram.org/bots/api#audio)). |
| [TelegramEncryptedCredentials](interfaces/TelegramEncryptedCredentials.md) | Describes data required for decrypting and authenticating [EncryptedPassportElement](https://core.telegram.org/bots/api#encryptedpassportelement). See the [Telegram Passport Documentation](https://core.telegram.org/passport#receiving-information) for a complete description of the data decryption and authentication processes. |
| [TelegramEncryptedPassportElement](interfaces/TelegramEncryptedPassportElement.md) | Describes documents or other Telegram Passport elements shared with the bot by the user. |
| [TelegramExternalReplyInfo](interfaces/TelegramExternalReplyInfo.md) | This object contains information about a message that is being replied to, which may come from another chat or forum topic. |
| [TelegramFile](interfaces/TelegramFile.md) | This object represents a file ready to be downloaded. The file can be downloaded via the link `https://api.telegram.org/file/bot<token>/<file_path>`. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling [getFile](https://core.telegram.org/bots/api#getfile). |
| [TelegramForceReply](interfaces/TelegramForceReply.md) | 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](https://core.telegram.org/bots/features#privacy-mode). Not supported in channels and for messages sent on behalf of a Telegram Business account. |
| [TelegramForumTopic](interfaces/TelegramForumTopic.md) | This object represents a forum topic. |
| [TelegramForumTopicClosed](interfaces/TelegramForumTopicClosed.md) | This object represents a service message about a forum topic closed in the chat. Currently holds no information. |
| [TelegramForumTopicCreated](interfaces/TelegramForumTopicCreated.md) | This object represents a service message about a new forum topic created in the chat. |
| [TelegramForumTopicEdited](interfaces/TelegramForumTopicEdited.md) | This object represents a service message about an edited forum topic. |
| [TelegramForumTopicReopened](interfaces/TelegramForumTopicReopened.md) | This object represents a service message about a forum topic reopened in the chat. Currently holds no information. |
| [TelegramGame](interfaces/TelegramGame.md) | This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers. |
| [TelegramGameHighScore](interfaces/TelegramGameHighScore.md) | This object represents one row of the high scores table for a game. |
| [TelegramGeneralForumTopicHidden](interfaces/TelegramGeneralForumTopicHidden.md) | This object represents a service message about General forum topic hidden in the chat. Currently holds no information. |
| [TelegramGeneralForumTopicUnhidden](interfaces/TelegramGeneralForumTopicUnhidden.md) | This object represents a service message about General forum topic unhidden in the chat. Currently holds no information. |
| [TelegramGift](interfaces/TelegramGift.md) | This object represents a gift that can be sent by the bot. |
| [TelegramGiftBackground](interfaces/TelegramGiftBackground.md) | This object describes the background of a gift. |
| [TelegramGiftInfo](interfaces/TelegramGiftInfo.md) | Describes a service message about a regular gift that was sent or received. |
| [TelegramGifts](interfaces/TelegramGifts.md) | This object represent a list of gifts. |
| [TelegramGiveaway](interfaces/TelegramGiveaway.md) | This object represents a message about a scheduled giveaway. |
| [TelegramGiveawayCompleted](interfaces/TelegramGiveawayCompleted.md) | This object represents a service message about the completion of a giveaway without public winners. |
| [TelegramGiveawayCreated](interfaces/TelegramGiveawayCreated.md) | This object represents a service message about the creation of a scheduled giveaway. |
| [TelegramGiveawayWinners](interfaces/TelegramGiveawayWinners.md) | This object represents a message about the completion of a giveaway with public winners. |
| [TelegramInaccessibleMessage](interfaces/TelegramInaccessibleMessage.md) | This object describes a message that was deleted or is otherwise inaccessible to the bot. |
| [TelegramInlineKeyboardButton](interfaces/TelegramInlineKeyboardButton.md) | This object represents one button of an inline keyboard. Exactly one of the fields other than *text*, *icon\_custom\_emoji\_id*, and *style* must be used to specify the type of the button. |
| [TelegramInlineKeyboardMarkup](interfaces/TelegramInlineKeyboardMarkup.md) | This object represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to. |
| [TelegramInlineQuery](interfaces/TelegramInlineQuery.md) | This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results. |
| [TelegramInlineQueryResultArticle](interfaces/TelegramInlineQueryResultArticle.md) | Represents a link to an article or web page. |
| [TelegramInlineQueryResultAudio](interfaces/TelegramInlineQueryResultAudio.md) | Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the audio. |
| [TelegramInlineQueryResultCachedAudio](interfaces/TelegramInlineQueryResultCachedAudio.md) | Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the audio. |
| [TelegramInlineQueryResultCachedDocument](interfaces/TelegramInlineQueryResultCachedDocument.md) | Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the file. |
| [TelegramInlineQueryResultCachedGif](interfaces/TelegramInlineQueryResultCachedGif.md) | Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with specified content instead of the animation. |
| [TelegramInlineQueryResultCachedMpeg4Gif](interfaces/TelegramInlineQueryResultCachedMpeg4Gif.md) | Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the animation. |
| [TelegramInlineQueryResultCachedPhoto](interfaces/TelegramInlineQueryResultCachedPhoto.md) | Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the photo. |
| [TelegramInlineQueryResultCachedSticker](interfaces/TelegramInlineQueryResultCachedSticker.md) | Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the sticker. |
| [TelegramInlineQueryResultCachedVideo](interfaces/TelegramInlineQueryResultCachedVideo.md) | Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the video. |
| [TelegramInlineQueryResultCachedVoice](interfaces/TelegramInlineQueryResultCachedVoice.md) | Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the voice message. |
| [TelegramInlineQueryResultContact](interfaces/TelegramInlineQueryResultContact.md) | Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the contact. |
| [TelegramInlineQueryResultDocument](interfaces/TelegramInlineQueryResultDocument.md) | Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the file. Currently, only **.PDF** and **.ZIP** files can be sent using this method. |
| [TelegramInlineQueryResultGame](interfaces/TelegramInlineQueryResultGame.md) | Represents a [Game](https://core.telegram.org/bots/api#games). |
| [TelegramInlineQueryResultGif](interfaces/TelegramInlineQueryResultGif.md) | Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the animation. |
| [TelegramInlineQueryResultLocation](interfaces/TelegramInlineQueryResultLocation.md) | Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the location. |
| [TelegramInlineQueryResultMpeg4Gif](interfaces/TelegramInlineQueryResultMpeg4Gif.md) | Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the animation. |
| [TelegramInlineQueryResultPhoto](interfaces/TelegramInlineQueryResultPhoto.md) | Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the photo. |
| [TelegramInlineQueryResultsButton](interfaces/TelegramInlineQueryResultsButton.md) | This object represents a button to be shown above inline query results. You **must** use exactly one of the optional fields. |
| [TelegramInlineQueryResultVenue](interfaces/TelegramInlineQueryResultVenue.md) | Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the venue. |
| [TelegramInlineQueryResultVideo](interfaces/TelegramInlineQueryResultVideo.md) | Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the video. |
| [TelegramInlineQueryResultVoice](interfaces/TelegramInlineQueryResultVoice.md) | Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the the voice message. |
| [TelegramInputChecklist](interfaces/TelegramInputChecklist.md) | Describes a checklist to create. |
| [TelegramInputChecklistTask](interfaces/TelegramInputChecklistTask.md) | Describes a task to add to a checklist. |
| [TelegramInputContactMessageContent](interfaces/TelegramInputContactMessageContent.md) | Represents the [content](https://core.telegram.org/bots/api#inputmessagecontent) of a contact message to be sent as the result of an inline query. |
| [TelegramInputInvoiceMessageContent](interfaces/TelegramInputInvoiceMessageContent.md) | Represents the [content](https://core.telegram.org/bots/api#inputmessagecontent) of an invoice message to be sent as the result of an inline query. |
| [TelegramInputLocationMessageContent](interfaces/TelegramInputLocationMessageContent.md) | Represents the [content](https://core.telegram.org/bots/api#inputmessagecontent) of a location message to be sent as the result of an inline query. |
| [TelegramInputMediaAnimation](interfaces/TelegramInputMediaAnimation.md) | Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent. |
| [TelegramInputMediaAudio](interfaces/TelegramInputMediaAudio.md) | Represents an audio file to be treated as music to be sent. |
| [TelegramInputMediaDocument](interfaces/TelegramInputMediaDocument.md) | Represents a general file to be sent. |
| [TelegramInputMediaPhoto](interfaces/TelegramInputMediaPhoto.md) | Represents a photo to be sent. |
| [TelegramInputMediaVideo](interfaces/TelegramInputMediaVideo.md) | Represents a video to be sent. |
| [TelegramInputPaidMediaPhoto](interfaces/TelegramInputPaidMediaPhoto.md) | The paid media to send is a photo. |
| [TelegramInputPaidMediaVideo](interfaces/TelegramInputPaidMediaVideo.md) | The paid media to send is a video. |
| [TelegramInputPollOption](interfaces/TelegramInputPollOption.md) | This object contains information about one answer option in a poll to be sent. |
| [TelegramInputProfilePhotoAnimated](interfaces/TelegramInputProfilePhotoAnimated.md) | An animated profile photo in the MPEG4 format. |
| [TelegramInputProfilePhotoStatic](interfaces/TelegramInputProfilePhotoStatic.md) | A static profile photo in the .JPG format. |
| [TelegramInputSticker](interfaces/TelegramInputSticker.md) | This object describes a sticker to be added to a sticker set. |
| [TelegramInputStoryContentPhoto](interfaces/TelegramInputStoryContentPhoto.md) | Describes a photo to post as a story. |
| [TelegramInputStoryContentVideo](interfaces/TelegramInputStoryContentVideo.md) | Describes a video to post as a story. |
| [TelegramInputTextMessageContent](interfaces/TelegramInputTextMessageContent.md) | Represents the [content](https://core.telegram.org/bots/api#inputmessagecontent) of a text message to be sent as the result of an inline query. |
| [TelegramInputVenueMessageContent](interfaces/TelegramInputVenueMessageContent.md) | Represents the [content](https://core.telegram.org/bots/api#inputmessagecontent) of a venue message to be sent as the result of an inline query. |
| [TelegramInvoice](interfaces/TelegramInvoice.md) | This object contains basic information about an invoice. |
| [TelegramKeyboardButton](interfaces/TelegramKeyboardButton.md) | This object represents one button of the reply keyboard. At most one of the fields other than *text*, *icon\_custom\_emoji\_id*, and *style* must be used to specify the type of the button. For simple text buttons, *String* can be used instead of this object to specify the button text. |
| [TelegramKeyboardButtonPollType](interfaces/TelegramKeyboardButtonPollType.md) | This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed. |
| [TelegramKeyboardButtonRequestChat](interfaces/TelegramKeyboardButtonRequestChat.md) | This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. [More about requesting chats »](https://core.telegram.org/bots/features#chat-and-user-selection). |
| [TelegramKeyboardButtonRequestUsers](interfaces/TelegramKeyboardButtonRequestUsers.md) | This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. [More about requesting users »](https://core.telegram.org/bots/features#chat-and-user-selection) |
| [TelegramLabeledPrice](interfaces/TelegramLabeledPrice.md) | This object represents a portion of the price for goods or services. |
| [TelegramLinkPreviewOptions](interfaces/TelegramLinkPreviewOptions.md) | Describes the options used for link preview generation. |
| [TelegramLocation](interfaces/TelegramLocation.md) | This object represents a point on the map. |
| [TelegramLocationAddress](interfaces/TelegramLocationAddress.md) | Describes the physical address of a location. |
| [TelegramLoginUrl](interfaces/TelegramLoginUrl.md) | This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the [Telegram Login Widget](https://core.telegram.org/widgets/login) when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in: |
| [TelegramMaskPosition](interfaces/TelegramMaskPosition.md) | This object describes the position on faces where a mask should be placed by default. |
| [TelegramMenuButtonCommands](interfaces/TelegramMenuButtonCommands.md) | Represents a menu button, which opens the bot's list of commands. |
| [TelegramMenuButtonDefault](interfaces/TelegramMenuButtonDefault.md) | Describes that no specific value for the menu button was set. |
| [TelegramMenuButtonWebApp](interfaces/TelegramMenuButtonWebApp.md) | Represents a menu button, which launches a [Web App](https://core.telegram.org/bots/webapps). |
| [TelegramMessage](interfaces/TelegramMessage.md) | This object represents a message. |
| [TelegramMessageAutoDeleteTimerChanged](interfaces/TelegramMessageAutoDeleteTimerChanged.md) | This object represents a service message about a change in auto-delete timer settings. |
| [TelegramMessageEntity](interfaces/TelegramMessageEntity.md) | This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc. |
| [TelegramMessageId](interfaces/TelegramMessageId.md) | This object represents a unique message identifier. |
| [TelegramMessageOriginChannel](interfaces/TelegramMessageOriginChannel.md) | The message was originally sent to a channel chat. |
| [TelegramMessageOriginChat](interfaces/TelegramMessageOriginChat.md) | The message was originally sent on behalf of a chat to a group chat. |
| [TelegramMessageOriginHiddenUser](interfaces/TelegramMessageOriginHiddenUser.md) | The message was originally sent by an unknown user. |
| [TelegramMessageOriginUser](interfaces/TelegramMessageOriginUser.md) | The message was originally sent by a known user. |
| [TelegramMessageReactionCountUpdated](interfaces/TelegramMessageReactionCountUpdated.md) | This object represents reaction changes on a message with anonymous reactions. |
| [TelegramMessageReactionUpdated](interfaces/TelegramMessageReactionUpdated.md) | This object represents a change of a reaction on a message performed by a user. |
| [TelegramOrderInfo](interfaces/TelegramOrderInfo.md) | This object represents information about an order. |
| [TelegramOwnedGiftRegular](interfaces/TelegramOwnedGiftRegular.md) | Describes a regular gift owned by a user or a chat. |
| [TelegramOwnedGifts](interfaces/TelegramOwnedGifts.md) | Contains the list of gifts received and owned by a user or a chat. |
| [TelegramOwnedGiftUnique](interfaces/TelegramOwnedGiftUnique.md) | Describes a unique gift received and owned by a user or a chat. |
| [TelegramPaidMediaInfo](interfaces/TelegramPaidMediaInfo.md) | Describes the paid media added to a message. |
| [TelegramPaidMediaPhoto](interfaces/TelegramPaidMediaPhoto.md) | The paid media is a photo. |
| [TelegramPaidMediaPreview](interfaces/TelegramPaidMediaPreview.md) | The paid media isn't available before the payment. |
| [TelegramPaidMediaPurchased](interfaces/TelegramPaidMediaPurchased.md) | This object contains information about a paid media purchase. |
| [TelegramPaidMediaVideo](interfaces/TelegramPaidMediaVideo.md) | The paid media is a video. |
| [TelegramPaidMessagePriceChanged](interfaces/TelegramPaidMessagePriceChanged.md) | Describes a service message about a change in the price of paid messages within a chat. |
| [TelegramPassportData](interfaces/TelegramPassportData.md) | Describes Telegram Passport data shared with the bot by the user. |
| [TelegramPassportElementErrorDataField](interfaces/TelegramPassportElementErrorDataField.md) | Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes. |
| [TelegramPassportElementErrorFile](interfaces/TelegramPassportElementErrorFile.md) | Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes. |
| [TelegramPassportElementErrorFiles](interfaces/TelegramPassportElementErrorFiles.md) | Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes. |
| [TelegramPassportElementErrorFrontSide](interfaces/TelegramPassportElementErrorFrontSide.md) | Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes. |
| [TelegramPassportElementErrorReverseSide](interfaces/TelegramPassportElementErrorReverseSide.md) | Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes. |
| [TelegramPassportElementErrorSelfie](interfaces/TelegramPassportElementErrorSelfie.md) | Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes. |
| [TelegramPassportElementErrorTranslationFile](interfaces/TelegramPassportElementErrorTranslationFile.md) | Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes. |
| [TelegramPassportElementErrorTranslationFiles](interfaces/TelegramPassportElementErrorTranslationFiles.md) | Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change. |
| [TelegramPassportElementErrorUnspecified](interfaces/TelegramPassportElementErrorUnspecified.md) | Represents an issue in an unspecified place. The error is considered resolved when new data is added. |
| [TelegramPassportFile](interfaces/TelegramPassportFile.md) | This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB. |
| [TelegramPhotoSize](interfaces/TelegramPhotoSize.md) | This object represents one size of a photo or a [file](https://core.telegram.org/bots/api#document) / [sticker](https://core.telegram.org/bots/api#sticker) thumbnail. |
| [TelegramPoll](interfaces/TelegramPoll.md) | This object contains information about a poll. |
| [TelegramPollAnswer](interfaces/TelegramPollAnswer.md) | This object represents an answer of a user in a non-anonymous poll. |
| [TelegramPollOption](interfaces/TelegramPollOption.md) | This object contains information about one answer option in a poll. |
| [TelegramPreCheckoutQuery](interfaces/TelegramPreCheckoutQuery.md) | This object contains information about an incoming pre-checkout query. |
| [TelegramPreparedInlineMessage](interfaces/TelegramPreparedInlineMessage.md) | Describes an inline message to be sent by a user of a Mini App. |
| [TelegramProximityAlertTriggered](interfaces/TelegramProximityAlertTriggered.md) | This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user. |
| [TelegramReactionCount](interfaces/TelegramReactionCount.md) | Represents a reaction added to a message along with the number of times it was added. |
| [TelegramReactionTypeCustomEmoji](interfaces/TelegramReactionTypeCustomEmoji.md) | The reaction is based on a custom emoji. |
| [TelegramReactionTypeEmoji](interfaces/TelegramReactionTypeEmoji.md) | The reaction is based on an emoji. |
| [TelegramReactionTypePaid](interfaces/TelegramReactionTypePaid.md) | The reaction is paid. |
| [TelegramRefundedPayment](interfaces/TelegramRefundedPayment.md) | This object contains basic information about a refunded payment. |
| [TelegramReplyKeyboardMarkup](interfaces/TelegramReplyKeyboardMarkup.md) | This object represents a [custom keyboard](https://core.telegram.org/bots/features#keyboards) with reply options (see [Introduction to bots](https://core.telegram.org/bots/features#keyboards) for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account. |
| [TelegramReplyKeyboardRemove](interfaces/TelegramReplyKeyboardRemove.md) | 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 (see [ReplyKeyboardMarkup](https://core.telegram.org/bots/api#replykeyboardmarkup)). Not supported in channels and for messages sent on behalf of a Telegram Business account. |
| [TelegramReplyParameters](interfaces/TelegramReplyParameters.md) | Describes reply parameters for the message that is being sent. |
| [TelegramResponseParameters](interfaces/TelegramResponseParameters.md) | Describes why a request was unsuccessful. |
| [TelegramRevenueWithdrawalStateFailed](interfaces/TelegramRevenueWithdrawalStateFailed.md) | The withdrawal failed and the transaction was refunded. |
| [TelegramRevenueWithdrawalStatePending](interfaces/TelegramRevenueWithdrawalStatePending.md) | The withdrawal is in progress. |
| [TelegramRevenueWithdrawalStateSucceeded](interfaces/TelegramRevenueWithdrawalStateSucceeded.md) | The withdrawal succeeded. |
| [TelegramSentWebAppMessage](interfaces/TelegramSentWebAppMessage.md) | Describes an inline message sent by a [Web App](https://core.telegram.org/bots/webapps) on behalf of a user. |
| [TelegramSharedUser](interfaces/TelegramSharedUser.md) | This object contains information about a user that was shared with the bot using a [KeyboardButtonRequestUsers](https://core.telegram.org/bots/api#keyboardbuttonrequestusers) button. |
| [TelegramShippingAddress](interfaces/TelegramShippingAddress.md) | This object represents a shipping address. |
| [TelegramShippingOption](interfaces/TelegramShippingOption.md) | This object represents one shipping option. |
| [TelegramShippingQuery](interfaces/TelegramShippingQuery.md) | This object contains information about an incoming shipping query. |
| [TelegramStarAmount](interfaces/TelegramStarAmount.md) | Describes an amount of Telegram Stars. |
| [TelegramStarTransaction](interfaces/TelegramStarTransaction.md) | Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control. |
| [TelegramStarTransactions](interfaces/TelegramStarTransactions.md) | Contains a list of Telegram Star transactions. |
| [TelegramSticker](interfaces/TelegramSticker.md) | This object represents a sticker. |
| [TelegramStickerSet](interfaces/TelegramStickerSet.md) | This object represents a sticker set. |
| [TelegramStory](interfaces/TelegramStory.md) | This object represents a story. |
| [TelegramStoryArea](interfaces/TelegramStoryArea.md) | Describes a clickable area on a story media. |
| [TelegramStoryAreaPosition](interfaces/TelegramStoryAreaPosition.md) | Describes the position of a clickable area within a story. |
| [TelegramStoryAreaTypeLink](interfaces/TelegramStoryAreaTypeLink.md) | Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas. |
| [TelegramStoryAreaTypeLocation](interfaces/TelegramStoryAreaTypeLocation.md) | Describes a story area pointing to a location. Currently, a story can have up to 10 location areas. |
| [TelegramStoryAreaTypeSuggestedReaction](interfaces/TelegramStoryAreaTypeSuggestedReaction.md) | Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas. |
| [TelegramStoryAreaTypeUniqueGift](interfaces/TelegramStoryAreaTypeUniqueGift.md) | Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area. |
| [TelegramStoryAreaTypeWeather](interfaces/TelegramStoryAreaTypeWeather.md) | Describes a story area containing weather information. Currently, a story can have up to 3 weather areas. |
| [TelegramSuccessfulPayment](interfaces/TelegramSuccessfulPayment.md) | This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control. |
| [TelegramSuggestedPostApprovalFailed](interfaces/TelegramSuggestedPostApprovalFailed.md) | Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient user funds at the time of approval. |
| [TelegramSuggestedPostApproved](interfaces/TelegramSuggestedPostApproved.md) | Describes a service message about the approval of a suggested post. |
| [TelegramSuggestedPostDeclined](interfaces/TelegramSuggestedPostDeclined.md) | Describes a service message about the rejection of a suggested post. |
| [TelegramSuggestedPostInfo](interfaces/TelegramSuggestedPostInfo.md) | Contains information about a suggested post. |
| [TelegramSuggestedPostPaid](interfaces/TelegramSuggestedPostPaid.md) | Describes a service message about a successful payment for a suggested post. |
| [TelegramSuggestedPostParameters](interfaces/TelegramSuggestedPostParameters.md) | Contains parameters of a post that is being suggested by the bot. |
| [TelegramSuggestedPostPrice](interfaces/TelegramSuggestedPostPrice.md) | Describes the price of a suggested post. |
| [TelegramSuggestedPostRefunded](interfaces/TelegramSuggestedPostRefunded.md) | Describes a service message about a payment refund for a suggested post. |
| [TelegramSwitchInlineQueryChosenChat](interfaces/TelegramSwitchInlineQueryChosenChat.md) | This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query. |
| [TelegramTextQuote](interfaces/TelegramTextQuote.md) | This object contains information about the quoted part of a message that is replied to by the given message. |
| [TelegramTransactionPartnerAffiliateProgram](interfaces/TelegramTransactionPartnerAffiliateProgram.md) | Describes the affiliate program that issued the affiliate commission received via this transaction. |
| [TelegramTransactionPartnerChat](interfaces/TelegramTransactionPartnerChat.md) | Describes a transaction with a chat. |
| [TelegramTransactionPartnerFragment](interfaces/TelegramTransactionPartnerFragment.md) | Describes a withdrawal transaction with Fragment. |
| [TelegramTransactionPartnerOther](interfaces/TelegramTransactionPartnerOther.md) | Describes a transaction with an unknown source or recipient. |
| [TelegramTransactionPartnerTelegramAds](interfaces/TelegramTransactionPartnerTelegramAds.md) | Describes a withdrawal transaction to the Telegram Ads platform. |
| [TelegramTransactionPartnerTelegramApi](interfaces/TelegramTransactionPartnerTelegramApi.md) | Describes a transaction with payment for [paid broadcasting](https://core.telegram.org/bots/api#paid-broadcasts). |
| [TelegramTransactionPartnerUser](interfaces/TelegramTransactionPartnerUser.md) | Describes a transaction with a user. |
| [TelegramUniqueGift](interfaces/TelegramUniqueGift.md) | This object describes a unique gift that was upgraded from a regular gift. |
| [TelegramUniqueGiftBackdrop](interfaces/TelegramUniqueGiftBackdrop.md) | This object describes the backdrop of a unique gift. |
| [TelegramUniqueGiftBackdropColors](interfaces/TelegramUniqueGiftBackdropColors.md) | This object describes the colors of the backdrop of a unique gift. |
| [TelegramUniqueGiftColors](interfaces/TelegramUniqueGiftColors.md) | This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift. |
| [TelegramUniqueGiftInfo](interfaces/TelegramUniqueGiftInfo.md) | Describes a service message about a unique gift that was sent or received. |
| [TelegramUniqueGiftModel](interfaces/TelegramUniqueGiftModel.md) | This object describes the model of a unique gift. |
| [TelegramUniqueGiftSymbol](interfaces/TelegramUniqueGiftSymbol.md) | This object describes the symbol shown on the pattern of a unique gift. |
| [TelegramUpdate](interfaces/TelegramUpdate.md) | This [object](https://core.telegram.org/bots/api#available-types) represents an incoming update. At most **one** of the optional parameters can be present in any given update. |
| [TelegramUser](interfaces/TelegramUser.md) | This object represents a Telegram user or bot. |
| [TelegramUserChatBoosts](interfaces/TelegramUserChatBoosts.md) | This object represents a list of boosts added to a chat by a user. |
| [TelegramUserProfileAudios](interfaces/TelegramUserProfileAudios.md) | This object represents the audios displayed on a user's profile. |
| [TelegramUserProfilePhotos](interfaces/TelegramUserProfilePhotos.md) | This object represent a user's profile pictures. |
| [TelegramUserRating](interfaces/TelegramUserRating.md) | This object describes the rating of a user based on their Telegram Star spendings. |
| [TelegramUsersShared](interfaces/TelegramUsersShared.md) | This object contains information about the users whose identifiers were shared with the bot using a [KeyboardButtonRequestUsers](https://core.telegram.org/bots/api#keyboardbuttonrequestusers) button. |
| [TelegramVenue](interfaces/TelegramVenue.md) | This object represents a venue. |
| [TelegramVideo](interfaces/TelegramVideo.md) | This object represents a video file. |
| [TelegramVideoChatEnded](interfaces/TelegramVideoChatEnded.md) | This object represents a service message about a video chat ended in the chat. |
| [TelegramVideoChatParticipantsInvited](interfaces/TelegramVideoChatParticipantsInvited.md) | This object represents a service message about new members invited to a video chat. |
| [TelegramVideoChatScheduled](interfaces/TelegramVideoChatScheduled.md) | This object represents a service message about a video chat scheduled in the chat. |
| [TelegramVideoChatStarted](interfaces/TelegramVideoChatStarted.md) | This object represents a service message about a video chat started in the chat. Currently holds no information. |
| [TelegramVideoNote](interfaces/TelegramVideoNote.md) | This object represents a [video message](https://telegram.org/blog/video-messages-and-telescope) (available in Telegram apps as of [v.4.0](https://telegram.org/blog/video-messages-and-telescope)). |
| [TelegramVideoQuality](interfaces/TelegramVideoQuality.md) | This object represents a video file of a specific quality. |
| [TelegramVoice](interfaces/TelegramVoice.md) | This object represents a voice note. |
| [TelegramWebAppData](interfaces/TelegramWebAppData.md) | Describes data sent from a [Web App](https://core.telegram.org/bots/webapps) to the bot. |
| [TelegramWebAppInfo](interfaces/TelegramWebAppInfo.md) | Describes a [Web App](https://core.telegram.org/bots/webapps). |
| [TelegramWebhookInfo](interfaces/TelegramWebhookInfo.md) | Describes the current status of a webhook. |
| [TelegramWriteAccessAllowed](interfaces/TelegramWriteAccessAllowed.md) | This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method [requestWriteAccess](https://core.telegram.org/bots/webapps#initializing-mini-apps). |
| [TransferBusinessAccountStarsParams](interfaces/TransferBusinessAccountStarsParams.md) | Params object for [transferBusinessAccountStars](interfaces/APIMethods.md#transferbusinessaccountstars) method |
| [TransferGiftParams](interfaces/TransferGiftParams.md) | Params object for [transferGift](interfaces/APIMethods.md#transfergift) method |
| [UnbanChatMemberParams](interfaces/UnbanChatMemberParams.md) | Params object for [unbanChatMember](interfaces/APIMethods.md#unbanchatmember) method |
| [UnbanChatSenderChatParams](interfaces/UnbanChatSenderChatParams.md) | Params object for [unbanChatSenderChat](interfaces/APIMethods.md#unbanchatsenderchat) method |
| [UnhideGeneralForumTopicParams](interfaces/UnhideGeneralForumTopicParams.md) | Params object for [unhideGeneralForumTopic](interfaces/APIMethods.md#unhidegeneralforumtopic) method |
| [UnpinAllChatMessagesParams](interfaces/UnpinAllChatMessagesParams.md) | Params object for [unpinAllChatMessages](interfaces/APIMethods.md#unpinallchatmessages) method |
| [UnpinAllForumTopicMessagesParams](interfaces/UnpinAllForumTopicMessagesParams.md) | Params object for [unpinAllForumTopicMessages](interfaces/APIMethods.md#unpinallforumtopicmessages) method |
| [UnpinAllGeneralForumTopicMessagesParams](interfaces/UnpinAllGeneralForumTopicMessagesParams.md) | Params object for [unpinAllGeneralForumTopicMessages](interfaces/APIMethods.md#unpinallgeneralforumtopicmessages) method |
| [UnpinChatMessageParams](interfaces/UnpinChatMessageParams.md) | Params object for [unpinChatMessage](interfaces/APIMethods.md#unpinchatmessage) method |
| [UpgradeGiftParams](interfaces/UpgradeGiftParams.md) | Params object for [upgradeGift](interfaces/APIMethods.md#upgradegift) method |
| [UploadStickerFileParams](interfaces/UploadStickerFileParams.md) | Params object for [uploadStickerFile](interfaces/APIMethods.md#uploadstickerfile) method |
| [VerifyChatParams](interfaces/VerifyChatParams.md) | Params object for [verifyChat](interfaces/APIMethods.md#verifychat) method |
| [VerifyUserParams](interfaces/VerifyUserParams.md) | Params object for [verifyUser](interfaces/APIMethods.md#verifyuser) method |
| [WebhookHandlerOptions](interfaces/WebhookHandlerOptions.md) | - |
| [WebhookHandlerOptionsShouldWait](interfaces/WebhookHandlerOptionsShouldWait.md) | - |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [AllowedUpdates](type-aliases/AllowedUpdates.md) | - |
| [AnyBot](type-aliases/AnyBot.md) | Type of Bot that accepts any generics |
| [AnyPlugin](type-aliases/AnyPlugin.md) | Type of Bot that accepts any generics |
| [APIMethodParams](type-aliases/APIMethodParams.md) | - |
| [APIMethodReturn](type-aliases/APIMethodReturn.md) | - |
| [BotStartOptionsLongPolling](type-aliases/BotStartOptionsLongPolling.md) | - |
| [BotStartOptionsWebhook](type-aliases/BotStartOptionsWebhook.md) | - |
| [CallbackQueryShorthandContext](type-aliases/CallbackQueryShorthandContext.md) | - |
| [CreateForumTopicIconColor](type-aliases/CreateForumTopicIconColor.md) | - |
| [CreateNewStickerSetStickerType](type-aliases/CreateNewStickerSetStickerType.md) | - |
| [DeriveDefinitions](type-aliases/DeriveDefinitions.md) | Map of derives |
| [ErrorDefinitions](type-aliases/ErrorDefinitions.md) | Error map should be map of string: error |
| [Filter](type-aliases/Filter.md) | A type guard predicate that narrows `In` to `Out`. Built-in filters use `any` as `In` so they work with any bot's context type. The actual narrowing happens via intersection in the `.on()` handler type. |
| [GiftPremiumSubscriptionMonthCount](type-aliases/GiftPremiumSubscriptionMonthCount.md) | - |
| [Handler](type-aliases/Handler.md) | Handler is a function with context and next function arguments |
| [MaybePromise](type-aliases/MaybePromise.md) | Type for maybe Promise or may not |
| [MaybeSuppressedParams](type-aliases/MaybeSuppressedParams.md) | Type that assign API params with [Suppress](interfaces/Suppress.md) |
| [MaybeSuppressedReturn](type-aliases/MaybeSuppressedReturn.md) | Type that return MaybeSuppressed API method ReturnType |
| [PostStoryActivePeriod](type-aliases/PostStoryActivePeriod.md) | - |
| [RepostStoryActivePeriod](type-aliases/RepostStoryActivePeriod.md) | - |
| [SendChatActionAction](type-aliases/SendChatActionAction.md) | - |
| [SendDiceEmoji](type-aliases/SendDiceEmoji.md) | - |
| [SendPollType](type-aliases/SendPollType.md) | - |
| [SetStickerSetThumbnailFormat](type-aliases/SetStickerSetThumbnailFormat.md) | - |
| [Stringable](type-aliases/Stringable.md) | Type which contains a string or has the ability to result in a string object |
| [SuppressedAPIMethodParams](type-aliases/SuppressedAPIMethodParams.md) | Return method params but with [Suppress](interfaces/Suppress.md) |
| [SuppressedAPIMethodReturn](type-aliases/SuppressedAPIMethodReturn.md) | Type that return [Suppressed](interfaces/Suppress.md) API method ReturnType |
| [SuppressedAPIMethods](type-aliases/SuppressedAPIMethods.md) | Map of APIMethods but with [Suppress](interfaces/Suppress.md) |
| [TelegramAPIResponse](type-aliases/TelegramAPIResponse.md) | The response contains a JSON object, which always has a Boolean field 'ok'. |
| [TelegramBackgroundFill](type-aliases/TelegramBackgroundFill.md) | This object describes the way a background is filled based on the selected colors. Currently, it can be one of |
| [TelegramBackgroundType](type-aliases/TelegramBackgroundType.md) | This object describes the type of a background. Currently, it can be one of |
| [TelegramBotCommandScope](type-aliases/TelegramBotCommandScope.md) | This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported: |
| [TelegramChatBoostSource](type-aliases/TelegramChatBoostSource.md) | This object describes the source of a chat boost. It can be one of |
| [TelegramChatFullInfoType](type-aliases/TelegramChatFullInfoType.md) | - |
| [TelegramChatMember](type-aliases/TelegramChatMember.md) | This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported: |
| [TelegramChatType](type-aliases/TelegramChatType.md) | - |
| [TelegramCurrencies](type-aliases/TelegramCurrencies.md) | Telegram payments supported currencies. Source: [currencies.json](https://core.telegram.org/bots/payments/currencies.json). See also [supported currencies](https://core.telegram.org/bots/payments/#supported-currencies). |
| [TelegramEncryptedPassportElementType](type-aliases/TelegramEncryptedPassportElementType.md) | - |
| [TelegramInlineKeyboardButtonStyle](type-aliases/TelegramInlineKeyboardButtonStyle.md) | - |
| [TelegramInlineQueryChatType](type-aliases/TelegramInlineQueryChatType.md) | - |
| [TelegramInlineQueryResult](type-aliases/TelegramInlineQueryResult.md) | This object represents one result of an inline query. Telegram clients currently support results of the following 20 types: |
| [TelegramInlineQueryResultDocumentMimeType](type-aliases/TelegramInlineQueryResultDocumentMimeType.md) | - |
| [TelegramInlineQueryResultGifThumbnailMimeType](type-aliases/TelegramInlineQueryResultGifThumbnailMimeType.md) | - |
| [TelegramInlineQueryResultMpeg4GifThumbnailMimeType](type-aliases/TelegramInlineQueryResultMpeg4GifThumbnailMimeType.md) | - |
| [TelegramInlineQueryResultVideoMimeType](type-aliases/TelegramInlineQueryResultVideoMimeType.md) | - |
| [TelegramInputFile](type-aliases/TelegramInputFile.md) | This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser. |
| [TelegramInputMedia](type-aliases/TelegramInputMedia.md) | This object represents the content of a media message to be sent. It should be one of |
| [TelegramInputMessageContent](type-aliases/TelegramInputMessageContent.md) | This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types: |
| [TelegramInputPaidMedia](type-aliases/TelegramInputPaidMedia.md) | This object describes the paid media to be sent. Currently, it can be one of |
| [TelegramInputProfilePhoto](type-aliases/TelegramInputProfilePhoto.md) | This object describes a profile photo to set. Currently, it can be one of |
| [TelegramInputStickerFormat](type-aliases/TelegramInputStickerFormat.md) | - |
| [TelegramInputStoryContent](type-aliases/TelegramInputStoryContent.md) | This object describes the content of a story to post. Currently, it can be one of |
| [TelegramKeyboardButtonStyle](type-aliases/TelegramKeyboardButtonStyle.md) | - |
| [TelegramMaskPositionPoint](type-aliases/TelegramMaskPositionPoint.md) | - |
| [TelegramMaybeInaccessibleMessage](type-aliases/TelegramMaybeInaccessibleMessage.md) | This object describes a message that can be inaccessible to the bot. It can be one of |
| [TelegramMenuButton](type-aliases/TelegramMenuButton.md) | This object describes the bot's menu button in a private chat. It should be one of |
| [TelegramMessageEntityType](type-aliases/TelegramMessageEntityType.md) | - |
| [TelegramMessageOrigin](type-aliases/TelegramMessageOrigin.md) | This object describes the origin of a message. It can be one of |
| [TelegramOwnedGift](type-aliases/TelegramOwnedGift.md) | This object describes a gift received and owned by a user or a chat. Currently, it can be one of |
| [TelegramPaidMedia](type-aliases/TelegramPaidMedia.md) | This object describes paid media. Currently, it can be one of |
| [TelegramPassportElementError](type-aliases/TelegramPassportElementError.md) | This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of: |
| [TelegramPassportElementErrorDataFieldType](type-aliases/TelegramPassportElementErrorDataFieldType.md) | - |
| [TelegramPassportElementErrorFilesType](type-aliases/TelegramPassportElementErrorFilesType.md) | - |
| [TelegramPassportElementErrorFileType](type-aliases/TelegramPassportElementErrorFileType.md) | - |
| [TelegramPassportElementErrorFrontSideType](type-aliases/TelegramPassportElementErrorFrontSideType.md) | - |
| [TelegramPassportElementErrorReverseSideType](type-aliases/TelegramPassportElementErrorReverseSideType.md) | - |
| [TelegramPassportElementErrorSelfieType](type-aliases/TelegramPassportElementErrorSelfieType.md) | - |
| [TelegramPassportElementErrorTranslationFilesType](type-aliases/TelegramPassportElementErrorTranslationFilesType.md) | - |
| [TelegramPassportElementErrorTranslationFileType](type-aliases/TelegramPassportElementErrorTranslationFileType.md) | - |
| [TelegramPollType](type-aliases/TelegramPollType.md) | - |
| [TelegramReactionType](type-aliases/TelegramReactionType.md) | This object describes the type of a reaction. Currently, it can be one of |
| [TelegramReactionTypeEmojiEmoji](type-aliases/TelegramReactionTypeEmojiEmoji.md) | - |
| [TelegramRevenueWithdrawalState](type-aliases/TelegramRevenueWithdrawalState.md) | This object describes the state of a revenue withdrawal operation. Currently, it can be one of |
| [TelegramStickerSetStickerType](type-aliases/TelegramStickerSetStickerType.md) | - |
| [TelegramStickerType](type-aliases/TelegramStickerType.md) | - |
| [TelegramStoryAreaType](type-aliases/TelegramStoryAreaType.md) | Describes the type of a clickable area on a story. Currently, it can be one of |
| [TelegramSuggestedPostInfoState](type-aliases/TelegramSuggestedPostInfoState.md) | - |
| [TelegramSuggestedPostPaidCurrency](type-aliases/TelegramSuggestedPostPaidCurrency.md) | - |
| [TelegramSuggestedPostPriceCurrency](type-aliases/TelegramSuggestedPostPriceCurrency.md) | - |
| [TelegramSuggestedPostRefundedReason](type-aliases/TelegramSuggestedPostRefundedReason.md) | - |
| [TelegramTransactionPartner](type-aliases/TelegramTransactionPartner.md) | This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of |
| [TelegramTransactionPartnerUserTransactionType](type-aliases/TelegramTransactionPartnerUserTransactionType.md) | - |
| [TelegramUniqueGiftInfoLastResaleCurrency](type-aliases/TelegramUniqueGiftInfoLastResaleCurrency.md) | - |
| [TelegramUniqueGiftInfoOrigin](type-aliases/TelegramUniqueGiftInfoOrigin.md) | - |
| [TelegramUniqueGiftModelRarity](type-aliases/TelegramUniqueGiftModelRarity.md) | - |
| [TelegramVideoQualityCodec](type-aliases/TelegramVideoQualityCodec.md) | - |
| [UploadStickerFileStickerFormat](type-aliases/UploadStickerFileStickerFormat.md) | - |
| [WebhookHandlers](type-aliases/WebhookHandlers.md) | Union type of webhook handlers name |

## Variables

### Composer

> `const` **Composer**: [`EventComposerConstructor`](../../composer/interfaces/EventComposerConstructor.md)<[`Context`](../../contexts/classes/Context.md)<[`AnyBot`](type-aliases/AnyBot.md)>, `TelegramEventMap`, { `callbackQuery`: `TThis`; `chosenInlineResult`: `TThis`; `command`: `TThis`; `hears`: `TThis`; `inlineQuery`: `TThis`; `reaction`: `TThis`; `startParameter`: `TThis`; }>

Defined in: gramio/index.d.ts:57

***

### ErrorKind

> `const` **ErrorKind**: `symbol`

Defined in: gramio/index.d.ts:18

Symbol to determine which error kind is it

***

### filters

> `const` **filters**: `object`

Defined in: gramio/index.d.ts:1382

#### Type Declaration

| Name | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `animation` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: [`AnimationAttachment`](../../contexts/classes/AnimationAttachment.md); }> | - | gramio/index.d.ts:1404 |
|  `audio` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: [`AudioAttachment`](../../contexts/classes/AudioAttachment.md); }> | - | gramio/index.d.ts:1392 |
|  `authorSignature` | [`Filter`](type-aliases/Filter.md)<`any`, { `authorSignature`: `string`; }> | Matches messages with an author signature | gramio/index.d.ts:1467 |
|  `caption` | [`Filter`](type-aliases/Filter.md)<`any`, { `caption`: `string`; }> | Matches messages that have a caption | gramio/index.d.ts:1425 |
|  `captionEntities` | [`Filter`](type-aliases/Filter.md)<`any`, { `captionEntities`: [`MessageEntity`](../../contexts/classes/MessageEntity.md)\[]; }> | Matches messages that have caption entities | gramio/index.d.ts:1443 |
|  `channel` | [`Filter`](type-aliases/Filter.md)<`any`, { `chat`: { `type`: `"channel"`; }; `chatType`: `"channel"`; }> | Matches channel chats. Narrows both `chatType` and `chat.type`. | gramio/index.d.ts:1580 |
|  `contact` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: [`ContactAttachment`](../../contexts/classes/ContactAttachment.md); }> | - | gramio/index.d.ts:1407 |
|  `dice` | [`Filter`](type-aliases/Filter.md)<`any`, { `dice`: [`Dice`](../../contexts/classes/Dice.md); }> | Matches messages that contain a dice | gramio/index.d.ts:1429 |
|  `document` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: [`DocumentAttachment`](../../contexts/classes/DocumentAttachment.md); }> | - | gramio/index.d.ts:1389 |
|  `effectId` | [`Filter`](type-aliases/Filter.md)<`any`, { `effectId`: `string`; }> | Matches messages with an effect ID | gramio/index.d.ts:1498 |
|  `entities` | [`Filter`](type-aliases/Filter.md)<`any`, { `entities`: [`MessageEntity`](../../contexts/classes/MessageEntity.md)\[]; }> | Matches messages that have text entities | gramio/index.d.ts:1439 |
|  `forwardOrigin` | `ForwardOriginFilter` | Matches forwarded messages. Call without args for any origin, or pass a type to narrow precisely. | gramio/index.d.ts:1433 |
|  `fromOffline()` | (`ctx`) => `boolean` | Matches messages sent while user was offline. No type narrowing. | gramio/index.d.ts:1526 |
|  `game` | [`Filter`](type-aliases/Filter.md)<`any`, { `game`: [`Game`](../../contexts/classes/Game.md); }> | Matches messages with a game | gramio/index.d.ts:1490 |
|  `giveaway` | [`Filter`](type-aliases/Filter.md)<`any`, { `giveaway`: [`Giveaway`](../../contexts/classes/Giveaway.md); }> | Matches giveaway messages | gramio/index.d.ts:1482 |
|  `group` | [`Filter`](type-aliases/Filter.md)<`any`, { `chat`: { `type`: `"group"`; }; `chatType`: `"group"`; }> | Matches group chats. Narrows both `chatType` and `chat.type`. | gramio/index.d.ts:1566 |
|  `hasData` | [`Filter`](type-aliases/Filter.md)<`any`, { `data`: `string`; }> | Matches callback queries that have data | gramio/index.d.ts:1532 |
|  `hasFrom` | [`Filter`](type-aliases/Filter.md)<`any`, { `from`: [`User`](../../contexts/classes/User.md); `senderId`: `number`; }> | Matches contexts that have a sender (from user) | gramio/index.d.ts:1475 |
|  `hasGameShortName` | [`Filter`](type-aliases/Filter.md)<`any`, { `gameShortName`: `string`; }> | Matches callback queries with a game short name | gramio/index.d.ts:1540 |
|  `hasInlineMessageId` | [`Filter`](type-aliases/Filter.md)<`any`, { `inlineMessageId`: `string`; }> | Matches callback queries with an inline message ID | gramio/index.d.ts:1536 |
|  `hasMessage` | [`Filter`](type-aliases/Filter.md)<`any`, { `message`: [`MessageContext`](../../contexts/classes/MessageContext.md)<`any`>; }> | Matches callback queries that have an associated message | gramio/index.d.ts:1528 |
|  `isBot()` | (`ctx`) => `boolean` | Matches messages from bot accounts | gramio/index.d.ts:1510 |
|  `isForum()` | (`ctx`) => `boolean` | Matches messages in forum (topic) chats | gramio/index.d.ts:1514 |
|  `isPremium()` | (`ctx`) => `boolean` | Matches messages from premium users | gramio/index.d.ts:1512 |
|  `linkPreview` | [`Filter`](type-aliases/Filter.md)<`any`, { `linkPreviewOptions`: [`LinkPreviewOptions`](../../contexts/classes/LinkPreviewOptions.md); }> | Matches messages that have link preview options | gramio/index.d.ts:1455 |
|  `location` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: [`LocationAttachment`](../../contexts/classes/LocationAttachment.md); }> | - | gramio/index.d.ts:1410 |
|  `media` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: `AnyAttachment`; }> | Matches any message that has an attachment | gramio/index.d.ts:1417 |
|  `mediaGroup` | [`Filter`](type-aliases/Filter.md)<`any`, { `mediaGroupId`: `string`; }> | Matches messages that belong to a media group | gramio/index.d.ts:1502 |
|  `mediaSpoiler` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: `AnyAttachment`; }> | Matches media with spoiler. Narrows `attachment` to confirm media is present. | gramio/index.d.ts:1520 |
|  `paidMedia` | [`Filter`](type-aliases/Filter.md)<`any`, { `paidMedia`: [`PaidMediaInfo`](../../contexts/classes/PaidMediaInfo.md); }> | Matches messages with paid media | gramio/index.d.ts:1486 |
|  `photo` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: [`PhotoAttachment`](../../contexts/classes/PhotoAttachment.md); }> | - | gramio/index.d.ts:1383 |
|  `pm` | [`Filter`](type-aliases/Filter.md)<`any`, { `chat`: { `type`: `"private"`; }; `chatType`: `"private"`; }> | Matches private (DM) chats. Narrows both `chatType` and `chat.type`. | gramio/index.d.ts:1559 |
|  `poll` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: [`PollAttachment`](../../contexts/classes/PollAttachment.md); }> | - | gramio/index.d.ts:1413 |
|  `protectedContent()` | (`ctx`) => `boolean` | Matches messages with protected content. No type narrowing. | gramio/index.d.ts:1524 |
|  `quote` | [`Filter`](type-aliases/Filter.md)<`any`, { `quote`: [`TextQuote`](../../contexts/classes/TextQuote.md); }> | Matches messages that have a quote | gramio/index.d.ts:1447 |
|  `rawStartPayload` | [`Filter`](type-aliases/Filter.md)<`any`, { `rawStartPayload`: `string`; }> | Matches messages with a raw /start payload string | gramio/index.d.ts:1463 |
|  `reply` | [`Filter`](type-aliases/Filter.md)<`any`, { `replyMessage`: [`Message`](../../contexts/classes/Message.md); }> | Matches messages that are replies | gramio/index.d.ts:1435 |
|  `replyInfo` | [`Filter`](type-aliases/Filter.md)<`any`, { `externalReply`: [`ExternalReplyInfo`](../../contexts/classes/ExternalReplyInfo.md); }> | Matches messages with external reply info | gramio/index.d.ts:1471 |
|  `senderChat` | `SenderChatFilter` | Matches messages sent on behalf of a chat. Pass a type to also narrow `senderChat.type`. | gramio/index.d.ts:1480 |
|  `service()` | (`ctx`) => `any` | Matches service messages | gramio/index.d.ts:1516 |
|  `startPayload` | [`Filter`](type-aliases/Filter.md)<`any`, { `startPayload`: `string`; }> | Matches messages with a /start payload | gramio/index.d.ts:1459 |
|  `sticker` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: [`StickerAttachment`](../../contexts/classes/StickerAttachment.md); }> | - | gramio/index.d.ts:1395 |
|  `story` | [`Filter`](type-aliases/Filter.md)<`any`, { `story`: [`StoryAttachment`](../../contexts/classes/StoryAttachment.md); }> | Matches messages with a story | gramio/index.d.ts:1494 |
|  `supergroup` | [`Filter`](type-aliases/Filter.md)<`any`, { `chat`: { `type`: `"supergroup"`; }; `chatType`: `"supergroup"`; }> | Matches supergroup chats. Narrows both `chatType` and `chat.type`. | gramio/index.d.ts:1573 |
|  `text` | [`Filter`](type-aliases/Filter.md)<`any`, { `text`: `string`; }> | Matches messages that have text | gramio/index.d.ts:1421 |
|  `topicMessage()` | (`ctx`) => `any` | Matches messages in topics | gramio/index.d.ts:1518 |
|  `venue` | [`Filter`](type-aliases/Filter.md)<`any`, { `venue`: [`Venue`](../../contexts/classes/Venue.md); }> | Matches messages with a venue | gramio/index.d.ts:1506 |
|  `viaBot` | [`Filter`](type-aliases/Filter.md)<`any`, { `viaBot`: [`User`](../../contexts/classes/User.md); }> | Matches messages sent via a bot | gramio/index.d.ts:1451 |
|  `video` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: [`VideoAttachment`](../../contexts/classes/VideoAttachment.md); }> | - | gramio/index.d.ts:1386 |
|  `videoNote` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: [`VideoNoteAttachment`](../../contexts/classes/VideoNoteAttachment.md); }> | - | gramio/index.d.ts:1401 |
|  `voice` | [`Filter`](type-aliases/Filter.md)<`any`, { `attachment`: [`VoiceAttachment`](../../contexts/classes/VoiceAttachment.md); }> | - | gramio/index.d.ts:1398 |
| `and()` | (`f1`, `f2`) => [`Filter`](type-aliases/Filter.md)<`any`, `N1` & `N2`> | Intersection: both filters must match | gramio/index.d.ts:1595 |
| `captionEntity()` | (`type`) => [`Filter`](type-aliases/Filter.md)<`any`, { `captionEntities`: [`MessageEntity`](../../contexts/classes/MessageEntity.md)\[]; }> | Matches messages with a specific caption entity type | gramio/index.d.ts:1548 |
| `chat()` | (`type`) => [`Filter`](type-aliases/Filter.md)<`any`, { `chat`: { `type`: `T`; }; `chatType`: `T`; }> | Matches messages from a specific chat type. Narrows both `chatType` and `chat.type`. | gramio/index.d.ts:1552 |
| `chatId()` | (`chatId`) => (`ctx`) => `boolean` | Matches messages in specific chat(s). No type narrowing. | gramio/index.d.ts:1589 |
| `entity()` | (`type`) => [`Filter`](type-aliases/Filter.md)<`any`, { `entities`: [`MessageEntity`](../../contexts/classes/MessageEntity.md)\[]; }> | Matches messages with a specific text entity type | gramio/index.d.ts:1544 |
| `every()` | (...`filters`) => [`Filter`](type-aliases/Filter.md)<`any`, `UnionToIntersection`<`ExtractNarrow`<`Filters`\[`number`]>>> | Variadic intersection: all filters must match | gramio/index.d.ts:1601 |
| `from()` | (`userId`) => (`ctx`) => `boolean` | Matches messages from specific user(s). No type narrowing. | gramio/index.d.ts:1587 |
| `not()` | (`f`) => (`ctx`) => `boolean` | Negation: inverts the filter (no type narrowing) | gramio/index.d.ts:1599 |
| `or()` | (`f1`, `f2`) => [`Filter`](type-aliases/Filter.md)<`any`, `N1` | `N2`> | Union: either filter must match | gramio/index.d.ts:1597 |
| `regex()` | (`pattern`) => [`Filter`](type-aliases/Filter.md)<`any`, { `match`: `RegExpMatchArray`; }> | Matches messages whose text/caption matches the regex, sets `ctx.match` | gramio/index.d.ts:1591 |
| `some()` | (...`filters`) => [`Filter`](type-aliases/Filter.md)<`any`, `ExtractNarrow`<`Filters`\[`number`]>> | Variadic union: any filter must match | gramio/index.d.ts:1603 |

## Functions

### getFormattable()

> **getFormattable**(`str`): [`FormattableString`](classes/FormattableString.md)

Defined in: format/formattable-string-BKevNsLk.d.ts:21

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `str` | [`Stringable`](type-aliases/Stringable.md) |

#### Returns

[`FormattableString`](classes/FormattableString.md)

***

### webhookHandler()

> **webhookHandler**<`Framework`>(`bot`, `framework`, `secretTokenOrOptions?`): `ReturnType`<`object`\[`Framework`]> *extends* `object` ? (...`args`) => `ReturnType`<`ReturnType`\[`"response"`]> : (...`args`) => `void`

Defined in: gramio/index.d.ts:1709

Setup handler with yours web-framework to receive updates via webhook

#### Type Parameters

| Type Parameter |
| ------ |
| `Framework` *extends* `"elysia"` | `"fastify"` | `"hono"` | `"express"` | `"koa"` | `"http"` | `"std/http"` | `"Bun.serve"` | `"cloudflare"` | `"Request"` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `bot` | [`Bot`](classes/Bot.md) |
| `framework` | `Framework` |
| `secretTokenOrOptions?` | `string` | [`WebhookHandlerOptions`](interfaces/WebhookHandlerOptions.md) |

#### Returns

`ReturnType`<`object`\[`Framework`]> *extends* `object` ? (...`args`) => `ReturnType`<`ReturnType`\[`"response"`]> : (...`args`) => `void`

#### Example

```ts
import { Bot } from "gramio";
import Fastify from "fastify";

const bot = new Bot(process.env.TOKEN as string).on(
	"message",
	(context) => {
		return context.send("Fastify!");
	},
);

const fastify = Fastify();

fastify.post("/telegram-webhook", webhookHandler(bot, "fastify"));

fastify.listen({ port: 3445, host: "::" });

bot.start({
    webhook: {
        url: "https://example.com:3445/telegram-webhook",
    },
});
```

## References

### AcceptedGiftTypes

Re-exports [AcceptedGiftTypes](../../contexts/classes/AcceptedGiftTypes.md)

***

### AnimationAttachment

Re-exports [AnimationAttachment](../../contexts/classes/AnimationAttachment.md)

***

### applyMixins

Re-exports [applyMixins](../../contexts/index.md#applymixins)

***

### Attachment

Re-exports [Attachment](../../contexts/classes/Attachment.md)

***

### AttachmentsMapping

Re-exports [AttachmentsMapping](../../contexts/interfaces/AttachmentsMapping.md)

***

### AttachmentType

Re-exports [AttachmentType](../../contexts/type-aliases/AttachmentType.md)

***

### AudioAttachment

Re-exports [AudioAttachment](../../contexts/classes/AudioAttachment.md)

***

### BackgroundFillFreeformGradient

Re-exports [BackgroundFillFreeformGradient](../../contexts/classes/BackgroundFillFreeformGradient.md)

***

### BackgroundFillGradient

Re-exports [BackgroundFillGradient](../../contexts/classes/BackgroundFillGradient.md)

***

### backgroundFillMap

Re-exports [backgroundFillMap](../../contexts/index.md#backgroundfillmap)

***

### BackgroundFillSolid

Re-exports [BackgroundFillSolid](../../contexts/classes/BackgroundFillSolid.md)

***

### BackgroundTypeChatTheme

Re-exports [BackgroundTypeChatTheme](../../contexts/classes/BackgroundTypeChatTheme.md)

***

### BackgroundTypeFill

Re-exports [BackgroundTypeFill](../../contexts/classes/BackgroundTypeFill.md)

***

### backgroundTypeMap

Re-exports [backgroundTypeMap](../../contexts/index.md#backgroundtypemap)

***

### BackgroundTypePattern

Re-exports [BackgroundTypePattern](../../contexts/classes/BackgroundTypePattern.md)

***

### BackgroundTypeWallpaper

Re-exports [BackgroundTypeWallpaper](../../contexts/classes/BackgroundTypeWallpaper.md)

***

### BaseKeyboardConstructor

Re-exports [BaseKeyboardConstructor](../../keyboards/classes/BaseKeyboardConstructor.md)

***

### Birthdate

Re-exports [Birthdate](../../contexts/classes/Birthdate.md)

***

### blockquote

Re-exports [blockquote](../../format/index.md#blockquote)

***

### bold

Re-exports [bold](../../format/index.md#bold)

***

### BoostAddedContext

Re-exports [BoostAddedContext](../../contexts/classes/BoostAddedContext.md)

***

### BotCommand

Re-exports [BotCommand](../../contexts/classes/BotCommand.md)

***

### BotDescription

Re-exports [BotDescription](../../contexts/classes/BotDescription.md)

***

### BotLike

Re-exports [BotLike](../../contexts/interfaces/BotLike.md)

***

### BotShortDescription

Re-exports [BotShortDescription](../../contexts/classes/BotShortDescription.md)

***

### buildFromOptions

Re-exports [buildFromOptions](../../composer/index.md#buildfromoptions)

***

### BusinessBotRights

Re-exports [BusinessBotRights](../../contexts/classes/BusinessBotRights.md)

***

### BusinessConnection

Re-exports [BusinessConnection](../../contexts/classes/BusinessConnection.md)

***

### BusinessConnectionContext

Re-exports [BusinessConnectionContext](../../contexts/classes/BusinessConnectionContext.md)

***

### BusinessIntro

Re-exports [BusinessIntro](../../contexts/classes/BusinessIntro.md)

***

### BusinessLocation

Re-exports [BusinessLocation](../../contexts/classes/BusinessLocation.md)

***

### BusinessMessagesDeleted

Re-exports [BusinessMessagesDeleted](../../contexts/classes/BusinessMessagesDeleted.md)

***

### BusinessMessagesDeletedContext

Re-exports [BusinessMessagesDeletedContext](../../contexts/classes/BusinessMessagesDeletedContext.md)

***

### BusinessOpeningHours

Re-exports [BusinessOpeningHours](../../contexts/classes/BusinessOpeningHours.md)

***

### BusinessOpeningHoursInterval

Re-exports [BusinessOpeningHoursInterval](../../contexts/classes/BusinessOpeningHoursInterval.md)

***

### ButtonOptions

Re-exports [ButtonOptions](../../keyboards/interfaces/ButtonOptions.md)

***

### ButtonsIterator

Re-exports [ButtonsIterator](../../keyboards/type-aliases/ButtonsIterator.md)

***

### CallbackData

Re-exports [CallbackData](../../callback-data/classes/CallbackData.md)

***

### CallbackGame

Re-exports [CallbackGame](../../contexts/classes/CallbackGame.md)

***

### CallbackQuery

Re-exports [CallbackQuery](../../contexts/classes/CallbackQuery.md)

***

### CallbackQueryContext

Re-exports [CallbackQueryContext](../../contexts/classes/CallbackQueryContext.md)

***

### Chat

Re-exports [Chat](../../contexts/classes/Chat.md)

***

### ChatActionMixin

Re-exports [ChatActionMixin](../../contexts/classes/ChatActionMixin.md)

***

### ChatAdministratorRights

Re-exports [ChatAdministratorRights](../../contexts/classes/ChatAdministratorRights.md)

***

### ChatBackground

Re-exports [ChatBackground](../../contexts/classes/ChatBackground.md)

***

### ChatBackgroundSetContext

Re-exports [ChatBackgroundSetContext](../../contexts/classes/ChatBackgroundSetContext.md)

***

### ChatBoost

Re-exports [ChatBoost](../../contexts/classes/ChatBoost.md)

***

### ChatBoostAdded

Re-exports [ChatBoostAdded](../../contexts/classes/ChatBoostAdded.md)

***

### ChatBoostContext

Re-exports [ChatBoostContext](../../contexts/classes/ChatBoostContext.md)

***

### ChatBoostRemoved

Re-exports [ChatBoostRemoved](../../contexts/classes/ChatBoostRemoved.md)

***

### ChatBoostSourceGiftCode

Re-exports [ChatBoostSourceGiftCode](../../contexts/classes/ChatBoostSourceGiftCode.md)

***

### ChatBoostSourceGiveaway

Re-exports [ChatBoostSourceGiveaway](../../contexts/classes/ChatBoostSourceGiveaway.md)

***

### ChatBoostSourcePremium

Re-exports [ChatBoostSourcePremium](../../contexts/classes/ChatBoostSourcePremium.md)

***

### ChatBoostUpdated

Re-exports [ChatBoostUpdated](../../contexts/classes/ChatBoostUpdated.md)

***

### ChatControlMixin

Re-exports [ChatControlMixin](../../contexts/classes/ChatControlMixin.md)

***

### ChatFullInfo

Re-exports [ChatFullInfo](../../contexts/classes/ChatFullInfo.md)

***

### ChatInviteControlMixin

Re-exports [ChatInviteControlMixin](../../contexts/classes/ChatInviteControlMixin.md)

***

### ChatInviteLink

Re-exports [ChatInviteLink](../../contexts/classes/ChatInviteLink.md)

***

### ChatJoinRequest

Re-exports [ChatJoinRequest](../../contexts/classes/ChatJoinRequest.md)

***

### ChatJoinRequestContext

Re-exports [ChatJoinRequestContext](../../contexts/classes/ChatJoinRequestContext.md)

***

### ChatLocation

Re-exports [ChatLocation](../../contexts/classes/ChatLocation.md)

***

### ChatMember

Re-exports [ChatMember](../../contexts/classes/ChatMember.md)

***

### ChatMemberContext

Re-exports [ChatMemberContext](../../contexts/classes/ChatMemberContext.md)

***

### ChatMemberControlMixin

Re-exports [ChatMemberControlMixin](../../contexts/classes/ChatMemberControlMixin.md)

***

### ChatMemberUpdated

Re-exports [ChatMemberUpdated](../../contexts/classes/ChatMemberUpdated.md)

***

### ChatOwnerChanged

Re-exports [ChatOwnerChanged](../../contexts/classes/ChatOwnerChanged.md)

***

### ChatOwnerChangedContext

Re-exports [ChatOwnerChangedContext](../../contexts/classes/ChatOwnerChangedContext.md)

***

### ChatOwnerLeft

Re-exports [ChatOwnerLeft](../../contexts/classes/ChatOwnerLeft.md)

***

### ChatOwnerLeftContext

Re-exports [ChatOwnerLeftContext](../../contexts/classes/ChatOwnerLeftContext.md)

***

### ChatPermissions

Re-exports [ChatPermissions](../../contexts/classes/ChatPermissions.md)

***

### ChatPhoto

Re-exports [ChatPhoto](../../contexts/classes/ChatPhoto.md)

***

### ChatSenderControlMixin

Re-exports [ChatSenderControlMixin](../../contexts/classes/ChatSenderControlMixin.md)

***

### ChatShared

Re-exports [ChatShared](../../contexts/classes/ChatShared.md)

***

### ChatSharedContext

Re-exports [ChatSharedContext](../../contexts/classes/ChatSharedContext.md)

***

### ChatType

Re-exports [ChatType](../../contexts/enumerations/ChatType.md)

***

### Checklist

Re-exports [Checklist](../../contexts/classes/Checklist.md)

***

### ChecklistTask

Re-exports [ChecklistTask](../../contexts/classes/ChecklistTask.md)

***

### ChecklistTasksAdded

Re-exports [ChecklistTasksAdded](../../contexts/classes/ChecklistTasksAdded.md)

***

### ChecklistTasksAddedContext

Re-exports [ChecklistTasksAddedContext](../../contexts/classes/ChecklistTasksAddedContext.md)

***

### ChecklistTasksDone

Re-exports [ChecklistTasksDone](../../contexts/classes/ChecklistTasksDone.md)

***

### ChecklistTasksDoneContext

Re-exports [ChecklistTasksDoneContext](../../contexts/classes/ChecklistTasksDoneContext.md)

***

### ChosenInlineResult

Re-exports [ChosenInlineResult](../../contexts/classes/ChosenInlineResult.md)

***

### ChosenInlineResultContext

Re-exports [ChosenInlineResultContext](../../contexts/classes/ChosenInlineResultContext.md)

***

### chunk

Re-exports [chunk](../../keyboards/index.md#chunk)

***

### CloneMixin

Re-exports [CloneMixin](../../contexts/classes/CloneMixin.md)

***

### code

Re-exports [code](../../format/index.md#code)

***

### compose

Re-exports [compose](../../composer/index.md#compose)

***

### Constructor

Re-exports [Constructor](../../contexts/type-aliases/Constructor.md)

***

### Contact

Re-exports [Contact](../../contexts/classes/Contact.md)

***

### ContactAttachment

Re-exports [ContactAttachment](../../contexts/classes/ContactAttachment.md)

***

### Context

Re-exports [Context](../../contexts/classes/Context.md)

***

### ContextCallback

Re-exports [ContextCallback](../../composer/interfaces/ContextCallback.md)

***

### ContextsMapping

Re-exports [ContextsMapping](../../contexts/type-aliases/ContextsMapping.md)

***

### contextsMappings

Re-exports [contextsMappings](../../contexts/index.md#contextsmappings)

***

### ContextType

Re-exports [ContextType](../../contexts/type-aliases/ContextType.md)

***

### convertJsonToFormData

Re-exports [convertJsonToFormData](../../files/index.md#convertjsontoformdata)

***

### convertStreamToBuffer

Re-exports [convertStreamToBuffer](../../files/index.md#convertstreamtobuffer)

***

### CreateButtonIterator

Re-exports [CreateButtonIterator](../../keyboards/type-aliases/CreateButtonIterator.md)

***

### customEmoji

Re-exports [customEmoji](../../format/index.md#customemoji)

***

### CustomEventName

Re-exports [CustomEventName](../../contexts/type-aliases/CustomEventName.md)

***

### customWrap

Re-exports [customWrap](../../keyboards/index.md#customwrap)

***

### dateTime

Re-exports [dateTime](../../format/index.md#datetime)

***

### DefaultAttachment

Re-exports [DefaultAttachment](../../contexts/interfaces/DefaultAttachment.md)

***

### DeleteChatPhotoContext

Re-exports [DeleteChatPhotoContext](../../contexts/classes/DeleteChatPhotoContext.md)

***

### DeriveFromOptions

Re-exports [DeriveFromOptions](../../composer/type-aliases/DeriveFromOptions.md)

***

### Dice

Re-exports [Dice](../../contexts/classes/Dice.md)

***

### DirectMessagePriceChanged

Re-exports [DirectMessagePriceChanged](../../contexts/classes/DirectMessagePriceChanged.md)

***

### DirectMessagePriceChangedContext

Re-exports [DirectMessagePriceChangedContext](../../contexts/classes/DirectMessagePriceChangedContext.md)

***

### DirectMessagesTopic

Re-exports [DirectMessagesTopic](../../contexts/classes/DirectMessagesTopic.md)

***

### DocumentAttachment

Re-exports [DocumentAttachment](../../contexts/classes/DocumentAttachment.md)

***

### DownloadMixin

Re-exports [DownloadMixin](../../contexts/classes/DownloadMixin.md)

***

### EncryptedCredentials

Re-exports [EncryptedCredentials](../../contexts/classes/EncryptedCredentials.md)

***

### EncryptedPassportElement

Re-exports [EncryptedPassportElement](../../contexts/classes/EncryptedPassportElement.md)

***

### EntityType

Re-exports [EntityType](../../contexts/enumerations/EntityType.md)

***

### EventComposer

Re-exports [EventComposer](../../composer/interfaces/EventComposer.md)

***

### EventQueue

Re-exports [EventQueue](../../composer/classes/EventQueue.md)

***

### EVENTS

Re-exports [EVENTS](../../contexts/index.md#events)

***

### expandableBlockquote

Re-exports [expandableBlockquote](../../format/index.md#expandableblockquote)

***

### ExternalReplyInfo

Re-exports [ExternalReplyInfo](../../contexts/classes/ExternalReplyInfo.md)

***

### extractFilesToFormData

Re-exports [extractFilesToFormData](../../files/index.md#extractfilestoformdata)

***

### File

Re-exports [File](../../contexts/classes/File.md)

***

### FileAttachment

Re-exports [FileAttachment](../../contexts/classes/FileAttachment.md)

***

### filter

Re-exports [filter](../../keyboards/index.md#filter)

***

### filterPayload

Re-exports [filterPayload](../../contexts/index.md#filterpayload)

***

### ForceReplyKeyboard

Re-exports [ForceReplyKeyboard](../../keyboards/classes/ForceReplyKeyboard.md)

***

### format

Re-exports [format](../../format/index.md#format)

***

### formatSaveIndents

Re-exports [formatSaveIndents](../../format/index.md#formatsaveindents)

***

### FormattableMap

Re-exports [FormattableMap](../../format/index.md#formattablemap)

***

### ForumMixin

Re-exports [ForumMixin](../../contexts/classes/ForumMixin.md)

***

### ForumTopicClosed

Re-exports [ForumTopicClosed](../../contexts/classes/ForumTopicClosed.md)

***

### ForumTopicClosedContext

Re-exports [ForumTopicClosedContext](../../contexts/classes/ForumTopicClosedContext.md)

***

### ForumTopicCreated

Re-exports [ForumTopicCreated](../../contexts/classes/ForumTopicCreated.md)

***

### ForumTopicCreatedContext

Re-exports [ForumTopicCreatedContext](../../contexts/classes/ForumTopicCreatedContext.md)

***

### ForumTopicEdited

Re-exports [ForumTopicEdited](../../contexts/classes/ForumTopicEdited.md)

***

### ForumTopicEditedContext

Re-exports [ForumTopicEditedContext](../../contexts/classes/ForumTopicEditedContext.md)

***

### ForumTopicReopened

Re-exports [ForumTopicReopened](../../contexts/classes/ForumTopicReopened.md)

***

### ForumTopicReopenedContext

Re-exports [ForumTopicReopenedContext](../../contexts/classes/ForumTopicReopenedContext.md)

***

### Game

Re-exports [Game](../../contexts/classes/Game.md)

***

### GeneralForumTopicHidden

Re-exports [GeneralForumTopicHidden](../../contexts/classes/GeneralForumTopicHidden.md)

***

### GeneralForumTopicHiddenContext

Re-exports [GeneralForumTopicHiddenContext](../../contexts/classes/GeneralForumTopicHiddenContext.md)

***

### GeneralForumTopicUnhidden

Re-exports [GeneralForumTopicUnhidden](../../contexts/classes/GeneralForumTopicUnhidden.md)

***

### GeneralForumTopicUnhiddenContext

Re-exports [GeneralForumTopicUnhiddenContext](../../contexts/classes/GeneralForumTopicUnhiddenContext.md)

***

### GetDerives

Re-exports [GetDerives](../../contexts/type-aliases/GetDerives.md)

***

### Gift

Re-exports [Gift](../../contexts/classes/Gift.md)

***

### GiftBackground

Re-exports [GiftBackground](../../contexts/classes/GiftBackground.md)

***

### GiftContext

Re-exports [GiftContext](../../contexts/classes/GiftContext.md)

***

### GiftInfo

Re-exports [GiftInfo](../../contexts/classes/GiftInfo.md)

***

### GiftUpgradeSentContext

Re-exports [GiftUpgradeSentContext](../../contexts/classes/GiftUpgradeSentContext.md)

***

### Giveaway

Re-exports [Giveaway](../../contexts/classes/Giveaway.md)

***

### GiveawayCompleted

Re-exports [GiveawayCompleted](../../contexts/classes/GiveawayCompleted.md)

***

### GiveawayCompletedContext

Re-exports [GiveawayCompletedContext](../../contexts/classes/GiveawayCompletedContext.md)

***

### GiveawayCreated

Re-exports [GiveawayCreated](../../contexts/classes/GiveawayCreated.md)

***

### GiveawayCreatedContext

Re-exports [GiveawayCreatedContext](../../contexts/classes/GiveawayCreatedContext.md)

***

### GiveawayWinners

Re-exports [GiveawayWinners](../../contexts/classes/GiveawayWinners.md)

***

### GiveawayWinnersContext

Re-exports [GiveawayWinnersContext](../../contexts/classes/GiveawayWinnersContext.md)

***

### GroupChatCreatedContext

Re-exports [GroupChatCreatedContext](../../contexts/classes/GroupChatCreatedContext.md)

***

### HandlerOptions

Re-exports [HandlerOptions](../../composer/type-aliases/HandlerOptions.md)

***

### InaccessibleMessage

Re-exports [InaccessibleMessage](../../contexts/classes/InaccessibleMessage.md)

***

### InferDataPack

Re-exports [InferDataPack](../../callback-data/type-aliases/InferDataPack.md)

***

### InferDataUnpack

Re-exports [InferDataUnpack](../../callback-data/type-aliases/InferDataUnpack.md)

***

### InlineKeyboard

Re-exports [InlineKeyboard](../../keyboards/classes/InlineKeyboard.md)

***

### InlineKeyboardButton

Re-exports [InlineKeyboardButton](../../contexts/classes/InlineKeyboardButton.md)

***

### InlineKeyboardMarkup

Re-exports [InlineKeyboardMarkup](../../contexts/classes/InlineKeyboardMarkup.md)

***

### InlineQuery

Re-exports [InlineQuery](../../contexts/classes/InlineQuery.md)

***

### InlineQueryContext

Re-exports [InlineQueryContext](../../contexts/classes/InlineQueryContext.md)

***

### InlineQueryResult

Re-exports [InlineQueryResult](../../keyboards/classes/InlineQueryResult.md)

***

### InlineQueryResultLocation

Re-exports [InlineQueryResultLocation](../../contexts/classes/InlineQueryResultLocation.md)

***

### InputChecklist

Re-exports [InputChecklist](../../contexts/classes/InputChecklist.md)

***

### InputChecklistTask

Re-exports [InputChecklistTask](../../contexts/classes/InputChecklistTask.md)

***

### InputLocationMessageContent

Re-exports [InputLocationMessageContent](../../contexts/classes/InputLocationMessageContent.md)

***

### InputMessageContent

Re-exports [InputMessageContent](../../keyboards/classes/InputMessageContent.md)

***

### InputPollOption

Re-exports [InputPollOption](../../contexts/classes/InputPollOption.md)

***

### Invoice

Re-exports [Invoice](../../contexts/classes/Invoice.md)

***

### InvoiceContext

Re-exports [InvoiceContext](../../contexts/classes/InvoiceContext.md)

***

### isBlob

Re-exports [isBlob](../../files/index.md#isblob)

***

### isMediaUpload

Re-exports [isMediaUpload](../../files/index.md#ismediaupload)

***

### isParsable

Re-exports [isParsable](../../contexts/index.md#isparsable)

***

### isPlainObject

Re-exports [isPlainObject](../../contexts/index.md#isplainobject)

***

### italic

Re-exports [italic](../../format/index.md#italic)

***

### join

Re-exports [join](../../format/index.md#join)

***

### JoinUnion

Re-exports [JoinUnion](../../contexts/type-aliases/JoinUnion.md)

***

### Keyboard

Re-exports [Keyboard](../../keyboards/classes/Keyboard.md)

***

### KeyboardFeatureFlags

Re-exports [KeyboardFeatureFlags](../../keyboards/interfaces/KeyboardFeatureFlags.md)

***

### KeyboardHelperColumns

Re-exports [KeyboardHelperColumns](../../keyboards/interfaces/KeyboardHelperColumns.md)

***

### KeyboardHelperFilter

Re-exports [KeyboardHelperFilter](../../keyboards/interfaces/KeyboardHelperFilter.md)

***

### KeyboardHelperPattern

Re-exports [KeyboardHelperPattern](../../keyboards/interfaces/KeyboardHelperPattern.md)

***

### KeyboardHelpers

Re-exports [KeyboardHelpers](../../keyboards/type-aliases/KeyboardHelpers.md)

***

### KeyboardHelperWrap

Re-exports [KeyboardHelperWrap](../../keyboards/interfaces/KeyboardHelperWrap.md)

***

### keyboardsFeatureFlagsMap

Re-exports [keyboardsFeatureFlagsMap](../../keyboards/index.md#keyboardsfeatureflagsmap)

***

### LeftChatMemberContext

Re-exports [LeftChatMemberContext](../../contexts/classes/LeftChatMemberContext.md)

***

### link

Re-exports [link](../../format/index.md#link)

***

### LinkPreviewOptions

Re-exports [LinkPreviewOptions](../../contexts/classes/LinkPreviewOptions.md)

***

### Location

Re-exports [Location](../../contexts/classes/Location.md)

***

### LocationAttachment

Re-exports [LocationAttachment](../../contexts/classes/LocationAttachment.md)

***

### LocationContext

Re-exports [LocationContext](../../contexts/classes/LocationContext.md)

***

### LoginUrl

Re-exports [LoginUrl](../../contexts/classes/LoginUrl.md)

***

### MacroDef

Re-exports [MacroDef](../../composer/type-aliases/MacroDef.md)

***

### MacroDefinitions

Re-exports [MacroDefinitions](../../composer/type-aliases/MacroDefinitions.md)

***

### MacroDeriveType

Re-exports [MacroDeriveType](../../composer/type-aliases/MacroDeriveType.md)

***

### MacroHooks

Re-exports [MacroHooks](../../composer/interfaces/MacroHooks.md)

***

### MacroOptionType

Re-exports [MacroOptionType](../../composer/type-aliases/MacroOptionType.md)

***

### MaskPosition

Re-exports [MaskPosition](../../contexts/classes/MaskPosition.md)

***

### MaybeArray

Re-exports [MaybeArray](../../contexts/type-aliases/MaybeArray.md)

***

### MEDIA\_METHODS

Re-exports [MEDIA\_METHODS](../../files/index.md#media_methods)

***

### MediaInput

Re-exports [MediaInput](../../files/classes/MediaInput.md)

***

### MediaUpload

Re-exports [MediaUpload](../../files/classes/MediaUpload.md)

***

### memoizeGetters

Re-exports [memoizeGetters](../../contexts/index.md#memoizegetters)

***

### mention

Re-exports [mention](../../format/index.md#mention)

***

### MenuButton

Re-exports [MenuButton](../../contexts/classes/MenuButton.md)

***

### Message

Re-exports [Message](../../contexts/classes/Message.md)

***

### MessageAutoDeleteTimerChanged

Re-exports [MessageAutoDeleteTimerChanged](../../contexts/classes/MessageAutoDeleteTimerChanged.md)

***

### MessageAutoDeleteTimerChangedContext

Re-exports [MessageAutoDeleteTimerChangedContext](../../contexts/classes/MessageAutoDeleteTimerChangedContext.md)

***

### MessageContext

Re-exports [MessageContext](../../contexts/classes/MessageContext.md)

***

### MessageContextWithRequiredFrom

Re-exports [MessageContextWithRequiredFrom](../../contexts/type-aliases/MessageContextWithRequiredFrom.md)

***

### MessageDraftPiece

Re-exports [MessageDraftPiece](../../contexts/type-aliases/MessageDraftPiece.md)

***

### MessageEntity

Re-exports [MessageEntity](../../contexts/classes/MessageEntity.md)

***

### MessageEventName

Re-exports [MessageEventName](../../contexts/type-aliases/MessageEventName.md)

***

### MessageId

Re-exports [MessageId](../../contexts/classes/MessageId.md)

***

### MessageOriginChannel

Re-exports [MessageOriginChannel](../../contexts/classes/MessageOriginChannel.md)

***

### MessageOriginChat

Re-exports [MessageOriginChat](../../contexts/classes/MessageOriginChat.md)

***

### MessageOriginHiddenUser

Re-exports [MessageOriginHiddenUser](../../contexts/classes/MessageOriginHiddenUser.md)

***

### MessageOriginUser

Re-exports [MessageOriginUser](../../contexts/classes/MessageOriginUser.md)

***

### MessageReactionContext

Re-exports [MessageReactionContext](../../contexts/classes/MessageReactionContext.md)

***

### MessageReactionCountContext

Re-exports [MessageReactionCountContext](../../contexts/classes/MessageReactionCountContext.md)

***

### MessageReactionCountUpdated

Re-exports [MessageReactionCountUpdated](../../contexts/classes/MessageReactionCountUpdated.md)

***

### MessageReactionUpdated

Re-exports [MessageReactionUpdated](../../contexts/classes/MessageReactionUpdated.md)

***

### Middleware

Re-exports [Middleware](../../composer/type-aliases/Middleware.md)

***

### MigrateFromChatIdContext

Re-exports [MigrateFromChatIdContext](../../contexts/classes/MigrateFromChatIdContext.md)

***

### MigrateToChatIdContext

Re-exports [MigrateToChatIdContext](../../contexts/classes/MigrateToChatIdContext.md)

***

### NewChatMembersContext

Re-exports [NewChatMembersContext](../../contexts/classes/NewChatMembersContext.md)

***

### NewChatPhotoContext

Re-exports [NewChatPhotoContext](../../contexts/classes/NewChatPhotoContext.md)

***

### NewChatTitleContext

Re-exports [NewChatTitleContext](../../contexts/classes/NewChatTitleContext.md)

***

### Next

Re-exports [Next](../../composer/type-aliases/Next.md)

***

### NodeMixin

Re-exports [NodeMixin](../../contexts/classes/NodeMixin.md)

***

### noopNext

Re-exports [noopNext](../../composer/index.md#noopnext)

***

### Optional

Re-exports [Optional](../../contexts/type-aliases/Optional.md)

***

### OrderInfo

Re-exports [OrderInfo](../../contexts/classes/OrderInfo.md)

***

### PaidMediaInfo

Re-exports [PaidMediaInfo](../../contexts/classes/PaidMediaInfo.md)

***

### paidMediaMap

Re-exports [paidMediaMap](../../contexts/index.md#paidmediamap)

***

### PaidMediaPhoto

Re-exports [PaidMediaPhoto](../../contexts/classes/PaidMediaPhoto.md)

***

### PaidMediaPreview

Re-exports [PaidMediaPreview](../../contexts/classes/PaidMediaPreview.md)

***

### PaidMediaPurchasedContext

Re-exports [PaidMediaPurchasedContext](../../contexts/classes/PaidMediaPurchasedContext.md)

***

### PaidMediaVideo

Re-exports [PaidMediaVideo](../../contexts/classes/PaidMediaVideo.md)

***

### PaidMessagePriceChangedContext

Re-exports [PaidMessagePriceChangedContext](../../contexts/classes/PaidMessagePriceChangedContext.md)

***

### PassportData

Re-exports [PassportData](../../contexts/classes/PassportData.md)

***

### PassportDataContext

Re-exports [PassportDataContext](../../contexts/classes/PassportDataContext.md)

***

### PassportFile

Re-exports [PassportFile](../../contexts/classes/PassportFile.md)

***

### pattern

Re-exports [pattern](../../keyboards/index.md#pattern)

***

### PhotoAttachment

Re-exports [PhotoAttachment](../../contexts/classes/PhotoAttachment.md)

***

### PhotoSize

Re-exports [PhotoSize](../../contexts/classes/PhotoSize.md)

***

### PinnedMessageContext

Re-exports [PinnedMessageContext](../../contexts/classes/PinnedMessageContext.md)

***

### PinsMixin

Re-exports [PinsMixin](../../contexts/classes/PinsMixin.md)

***

### Poll

Re-exports [Poll](../../contexts/classes/Poll.md)

***

### PollAnswer

Re-exports [PollAnswer](../../contexts/classes/PollAnswer.md)

***

### PollAnswerContext

Re-exports [PollAnswerContext](../../contexts/classes/PollAnswerContext.md)

***

### PollAttachment

Re-exports [PollAttachment](../../contexts/classes/PollAttachment.md)

***

### PollContext

Re-exports [PollContext](../../contexts/classes/PollContext.md)

***

### PollOption

Re-exports [PollOption](../../contexts/classes/PollOption.md)

***

### PollType

Re-exports [PollType](../../contexts/enumerations/PollType.md)

***

### pre

Re-exports [pre](../../format/index.md#pre)

***

### PreCheckoutQuery

Re-exports [PreCheckoutQuery](../../contexts/classes/PreCheckoutQuery.md)

***

### PreCheckoutQueryContext

Re-exports [PreCheckoutQueryContext](../../contexts/classes/PreCheckoutQueryContext.md)

***

### ProximityAlertTriggered

Re-exports [ProximityAlertTriggered](../../contexts/classes/ProximityAlertTriggered.md)

***

### ProximityAlertTriggeredContext

Re-exports [ProximityAlertTriggeredContext](../../contexts/classes/ProximityAlertTriggeredContext.md)

***

### ReactionCount

Re-exports [ReactionCount](../../contexts/classes/ReactionCount.md)

***

### ReactionTypeCustomEmoji

Re-exports [ReactionTypeCustomEmoji](../../contexts/classes/ReactionTypeCustomEmoji.md)

***

### ReactionTypeEmoji

Re-exports [ReactionTypeEmoji](../../contexts/classes/ReactionTypeEmoji.md)

***

### ReactionTypePaid

Re-exports [ReactionTypePaid](../../contexts/classes/ReactionTypePaid.md)

***

### RefundedPayment

Re-exports [RefundedPayment](../../contexts/classes/RefundedPayment.md)

***

### RefundedPaymentContext

Re-exports [RefundedPaymentContext](../../contexts/classes/RefundedPaymentContext.md)

***

### RemovedChatBoostContext

Re-exports [RemovedChatBoostContext](../../contexts/classes/RemovedChatBoostContext.md)

***

### RemoveKeyboard

Re-exports [RemoveKeyboard](../../keyboards/classes/RemoveKeyboard.md)

***

### Require

Re-exports [Require](../../contexts/type-aliases/Require.md)

***

### RequireValue

Re-exports [RequireValue](../../contexts/type-aliases/RequireValue.md)

***

### SafeUnpackResult

Re-exports [SafeUnpackResult](../../callback-data/type-aliases/SafeUnpackResult.md)

***

### SendMixin

Re-exports [SendMixin](../../contexts/classes/SendMixin.md)

***

### SentWebAppMessage

Re-exports [SentWebAppMessage](../../contexts/classes/SentWebAppMessage.md)

***

### SERVICE\_MESSAGE\_EVENTS

Re-exports [SERVICE\_MESSAGE\_EVENTS](../../contexts/index.md#service_message_events)

***

### SharedUser

Re-exports [SharedUser](../../contexts/classes/SharedUser.md)

***

### ShippingAddress

Re-exports [ShippingAddress](../../contexts/classes/ShippingAddress.md)

***

### ShippingQuery

Re-exports [ShippingQuery](../../contexts/classes/ShippingQuery.md)

***

### ShippingQueryContext

Re-exports [ShippingQueryContext](../../contexts/classes/ShippingQueryContext.md)

***

### skip

Re-exports [skip](../../composer/index.md#skip)

***

### sleep

Re-exports [sleep](../../contexts/index.md#sleep)

***

### SoftString

Re-exports [SoftString](../../contexts/type-aliases/SoftString.md)

***

### spoiler

Re-exports [spoiler](../../format/index.md#spoiler)

***

### StickerAttachment

Re-exports [StickerAttachment](../../contexts/classes/StickerAttachment.md)

***

### StickerSet

Re-exports [StickerSet](../../contexts/classes/StickerSet.md)

***

### stop

Re-exports [stop](../../composer/index.md#stop)

***

### Story

Re-exports [Story](../../contexts/classes/Story.md)

***

### StoryAttachment

Re-exports [StoryAttachment](../../contexts/classes/StoryAttachment.md)

***

### StreamMessageOptions

Re-exports [StreamMessageOptions](../../contexts/interfaces/StreamMessageOptions.md)

***

### strikethrough

Re-exports [strikethrough](../../format/index.md#strikethrough)

***

### SuccessfulPayment

Re-exports [SuccessfulPayment](../../contexts/classes/SuccessfulPayment.md)

***

### SuccessfulPaymentContext

Re-exports [SuccessfulPaymentContext](../../contexts/classes/SuccessfulPaymentContext.md)

***

### SuggestedPostApprovalFailed

Re-exports [SuggestedPostApprovalFailed](../../contexts/classes/SuggestedPostApprovalFailed.md)

***

### SuggestedPostApprovalFailedContext

Re-exports [SuggestedPostApprovalFailedContext](../../contexts/classes/SuggestedPostApprovalFailedContext.md)

***

### SuggestedPostApproved

Re-exports [SuggestedPostApproved](../../contexts/classes/SuggestedPostApproved.md)

***

### SuggestedPostApprovedContext

Re-exports [SuggestedPostApprovedContext](../../contexts/classes/SuggestedPostApprovedContext.md)

***

### SuggestedPostDeclined

Re-exports [SuggestedPostDeclined](../../contexts/classes/SuggestedPostDeclined.md)

***

### SuggestedPostDeclinedContext

Re-exports [SuggestedPostDeclinedContext](../../contexts/classes/SuggestedPostDeclinedContext.md)

***

### SuggestedPostInfo

Re-exports [SuggestedPostInfo](../../contexts/classes/SuggestedPostInfo.md)

***

### SuggestedPostPaid

Re-exports [SuggestedPostPaid](../../contexts/classes/SuggestedPostPaid.md)

***

### SuggestedPostPaidContext

Re-exports [SuggestedPostPaidContext](../../contexts/classes/SuggestedPostPaidContext.md)

***

### SuggestedPostPrice

Re-exports [SuggestedPostPrice](../../contexts/classes/SuggestedPostPrice.md)

***

### SuggestedPostRefunded

Re-exports [SuggestedPostRefunded](../../contexts/classes/SuggestedPostRefunded.md)

***

### SuggestedPostRefundedContext

Re-exports [SuggestedPostRefundedContext](../../contexts/classes/SuggestedPostRefundedContext.md)

***

### TargetMixin

Re-exports [TargetMixin](../../contexts/classes/TargetMixin.md)

***

### TextQuote

Re-exports [TextQuote](../../contexts/classes/TextQuote.md)

***

### tSendAnimation

Re-exports [tSendAnimation](../../contexts/type-aliases/tSendAnimation.md)

***

### tSendAudio

Re-exports [tSendAudio](../../contexts/type-aliases/tSendAudio.md)

***

### tSendDocument

Re-exports [tSendDocument](../../contexts/type-aliases/tSendDocument.md)

***

### tSendMethods

Re-exports [tSendMethods](../../contexts/type-aliases/tSendMethods.md)

***

### tSendPhoto

Re-exports [tSendPhoto](../../contexts/type-aliases/tSendPhoto.md)

***

### tSendSticker

Re-exports [tSendSticker](../../contexts/type-aliases/tSendSticker.md)

***

### tSendVideo

Re-exports [tSendVideo](../../contexts/type-aliases/tSendVideo.md)

***

### tSendVideoNote

Re-exports [tSendVideoNote](../../contexts/type-aliases/tSendVideoNote.md)

***

### tSendVoice

Re-exports [tSendVoice](../../contexts/type-aliases/tSendVoice.md)

***

### underline

Re-exports [underline](../../format/index.md#underline)

***

### UniqueGift

Re-exports [UniqueGift](../../contexts/classes/UniqueGift.md)

***

### UniqueGiftBackdrop

Re-exports [UniqueGiftBackdrop](../../contexts/classes/UniqueGiftBackdrop.md)

***

### UniqueGiftBackdropColors

Re-exports [UniqueGiftBackdropColors](../../contexts/classes/UniqueGiftBackdropColors.md)

***

### UniqueGiftColors

Re-exports [UniqueGiftColors](../../contexts/classes/UniqueGiftColors.md)

***

### UniqueGiftContext

Re-exports [UniqueGiftContext](../../contexts/classes/UniqueGiftContext.md)

***

### UniqueGiftInfo

Re-exports [UniqueGiftInfo](../../contexts/classes/UniqueGiftInfo.md)

***

### UniqueGiftModel

Re-exports [UniqueGiftModel](../../contexts/classes/UniqueGiftModel.md)

***

### UniqueGiftSymbol

Re-exports [UniqueGiftSymbol](../../contexts/classes/UniqueGiftSymbol.md)

***

### Update

Re-exports [Update](../../contexts/classes/Update.md)

***

### UpdateName

Re-exports [UpdateName](../../contexts/type-aliases/UpdateName.md)

***

### User

Re-exports [User](../../contexts/classes/User.md)

***

### UserProfileAudios

Re-exports [UserProfileAudios](../../contexts/classes/UserProfileAudios.md)

***

### UserProfilePhotos

Re-exports [UserProfilePhotos](../../contexts/classes/UserProfilePhotos.md)

***

### UserRating

Re-exports [UserRating](../../contexts/classes/UserRating.md)

***

### UsersShared

Re-exports [UsersShared](../../contexts/classes/UsersShared.md)

***

### UsersSharedContext

Re-exports [UsersSharedContext](../../contexts/classes/UsersSharedContext.md)

***

### Venue

Re-exports [Venue](../../contexts/classes/Venue.md)

***

### VenueAttachment

Re-exports [VenueAttachment](../../contexts/classes/VenueAttachment.md)

***

### VideoAttachment

Re-exports [VideoAttachment](../../contexts/classes/VideoAttachment.md)

***

### VideoChatEnded

Re-exports [VideoChatEnded](../../contexts/classes/VideoChatEnded.md)

***

### VideoChatEndedContext

Re-exports [VideoChatEndedContext](../../contexts/classes/VideoChatEndedContext.md)

***

### VideoChatParticipantsInvited

Re-exports [VideoChatParticipantsInvited](../../contexts/classes/VideoChatParticipantsInvited.md)

***

### VideoChatParticipantsInvitedContext

Re-exports [VideoChatParticipantsInvitedContext](../../contexts/classes/VideoChatParticipantsInvitedContext.md)

***

### VideoChatScheduled

Re-exports [VideoChatScheduled](../../contexts/classes/VideoChatScheduled.md)

***

### VideoChatScheduledContext

Re-exports [VideoChatScheduledContext](../../contexts/classes/VideoChatScheduledContext.md)

***

### VideoChatStarted

Re-exports [VideoChatStarted](../../contexts/classes/VideoChatStarted.md)

***

### VideoChatStartedContext

Re-exports [VideoChatStartedContext](../../contexts/classes/VideoChatStartedContext.md)

***

### VideoNoteAttachment

Re-exports [VideoNoteAttachment](../../contexts/classes/VideoNoteAttachment.md)

***

### VideoQuality

Re-exports [VideoQuality](../../contexts/classes/VideoQuality.md)

***

### VoiceAttachment

Re-exports [VoiceAttachment](../../contexts/classes/VoiceAttachment.md)

***

### WebAppData

Re-exports [WebAppData](../../contexts/classes/WebAppData.md)

***

### WebAppDataContext

Re-exports [WebAppDataContext](../../contexts/classes/WebAppDataContext.md)

***

### WebAppInfo

Re-exports [WebAppInfo](../../contexts/classes/WebAppInfo.md)

***

### WithCtx

Re-exports [WithCtx](../../composer/type-aliases/WithCtx.md)

***

### WriteAccessAllowed

Re-exports [WriteAccessAllowed](../../contexts/classes/WriteAccessAllowed.md)

***

### WriteAccessAllowedContext

Re-exports [WriteAccessAllowedContext](../../contexts/classes/WriteAccessAllowedContext.md)

---

---
url: 'https://gramio.dev/triggers/reaction.md'
---

# reaction

The `reaction` method is used to register a handler for changes in reactions on a message. This method allows your bot to respond when a user reacts to a message with an emoji. By specifying the trigger (which emoji to listen for) and the corresponding handler, you can customize how your bot responds to these interactions.

## Key Features

### Handling Reactions

To use the `reaction` method, you define a trigger (or multiple triggers) and a handler. The trigger is the emoji (or emojis) that, when reacted to a message, will cause the handler to execute.

```ts
bot.reaction("👍", async (context) => {
    await context.reply(`Thank you!`);
});
```

In this example:

* The `reaction` method is called with the trigger `"👍"`, which is an emoji.
* Whenever a user reacts to a message with a thumbs-up emoji (`👍`), the bot will execute the handler and reply with "Thank you!".

### Trigger Types

The `trigger` parameter can be a single emoji or an array of emojis. The handler will execute if any of the specified emojis are used.

```ts
bot.reaction(["👍", "❤️"], async (context) => {
    await context.reply(`Thanks for your reaction!`);
});
```

In this example:

* The bot will respond if a user reacts with either a thumbs-up (`👍`) or a heart (`❤️`).

---

---
url: 'https://gramio.dev/api/gramio/namespaces/Hooks.md'
---
[GramIO API Reference](../../../../index.md) / [gramio/dist](../../index.md) / Hooks

# Hooks

Namespace with GramIO hooks types

[Documentation](https://gramio.dev/hooks/overview.html)

## Interfaces

| Interface | Description |
| ------ | ------ |
| [Store](interfaces/Store.md) | Store hooks |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [Derive](type-aliases/Derive.md) | Derive |
| [OnApiCall](type-aliases/OnApiCall.md) | Type for `onApiCall` hook (wrap-style) |
| [OnApiCallContext](type-aliases/OnApiCallContext.md) | Argument type for [OnApiCall](type-aliases/OnApiCall.md) |
| [OnError](type-aliases/OnError.md) | Type for `onError` hook |
| [OnErrorContext](type-aliases/OnErrorContext.md) | Argument type for [OnError](type-aliases/OnError.md) |
| [OnResponse](type-aliases/OnResponse.md) | Type for `onResponse` hook |
| [OnResponseError](type-aliases/OnResponseError.md) | Type for `onResponseError` hook |
| [OnStart](type-aliases/OnStart.md) | Type for `onStart` hook |
| [OnStop](type-aliases/OnStop.md) | Type for `onStop` hook |
| [PreRequest](type-aliases/PreRequest.md) | Type for `preRequest` hook |
| [PreRequestContext](type-aliases/PreRequestContext.md) | Argument type for [PreRequest](type-aliases/PreRequest.md) |

---

---
url: 'https://gramio.dev/hooks/overview.md'
---

# Hooks

The hook system allows us to hook on to the lifecycle of the API request/context and somehow impact it.

Below are the hooks available in GramIO:

* [onStart](/hooks/on-start) - called when the bot is started
* [onStop](/hooks/on-stop) - called when the bot stops
* [onError](/hooks/on-error) - called when an error occurs in the contexts
* [preRequest](/hooks/pre-request) - called before sending a request to Telegram Bot API (allows us to impact the sent parameters)
* [onResponse](/hooks/on-response) - called on API request response (only if success)
* [onResponseError](/hooks/on-response-error) - called on API request response (only if errored)
* onApiCall - wraps the entire API call lifecycle for instrumentation and tracing

---

---
url: 'https://gramio.dev/rate-limits.md'
---

# Rate limits

Telegram Bot API enforces strict rate limits to protect its infrastructure and other bots from abuse. If your bot sends too many requests in a short period, the API will respond with **HTTP 429 — Too Many Requests** and a `retry_after` field indicating how many seconds the bot must wait before making any API calls.

## Key limits to know

Telegram **does not officially publish** exact rate limit numbers. The values below are approximate and come from community experience — they are safe to follow, but the real limits are **dynamic** and depend on factors like your bot's age, history, and the type of requests.

| Limit | Approximate value |
|---|---|
| Messages to the **same chat** | ~1 per second |
| Messages to **different chats** | ~30 per second |
| Bulk notifications / broadcasts | ~30 per second total |
| Group/channel operations | Lower, depends on members |
| **Paid** broadcast (`allow_paid_broadcast`) | Up to **1000 per second** (0.1 Stars/msg) |

> \[!NOTE]
> In practice the limits are more nuanced than a simple "30 per second" — they can change dynamically and may differ between bots. If your bot needs higher throughput, you can **contact [@BotSupport](https://t.me/BotSupport)** and request a limit increase for your bot.

> \[!TIP]
> If you're not doing broadcasts — just responding to user messages — you almost certainly won't hit these limits. But it's still good practice to add the [auto-retry](/plugins/official/auto-retry) plugin as a safety net.

## What happens when you exceed the limit

When you go over the rate limit, Telegram returns:

```json
{
  "ok": false,
  "error_code": 429,
  "description": "Too Many Requests: retry after 35",
  "parameters": {
    "retry_after": 35
  }
}
```

Your bot is **completely blocked** for the duration of `retry_after` (up to 35+ seconds). No API calls will succeed during this time — not just for the users you were broadcasting to, but for **all** users interacting with your bot.

## The problem: broadcasting without delays

A common mistake is iterating over a list of users and sending messages as fast as possible:

```ts
// DON'T do this!
for (const chatId of chatIds) {
    await bot.api.sendMessage({ chat_id: chatId, text: "Hi!" });
    // No delay → instant 429 after ~30 messages
}
```

This fires requests at maximum speed. After roughly 30 messages, Telegram blocks your bot entirely.

## How to broadcast correctly

### Paid approach: `allow_paid_broadcast`

If budget allows, the simplest way to bypass rate limits entirely is the `allow_paid_broadcast` parameter. Pass `true` to any send method (e.g. [`sendMessage`](/telegram/methods/sendMessage)) and your bot can send **up to 1000 messages per second** — at a cost of **0.1 Telegram Stars per message**, withdrawn automatically from the bot's balance.

```ts twoslash
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string);
const chatIds: number[] = [
    /** some chat ids */
];

for (const chatId of chatIds) {
    await bot.api.sendMessage({
        chat_id: chatId,
        text: "Hi!",
        allow_paid_broadcast: true,
    });
}
```

> \[!TIP]
> `allow_paid_broadcast` doesn't replace retry logic — you should still handle transient errors. Combine it with [auto-retry](/plugins/official/auto-retry) for a robust solution.

> \[!WARNING]
> Make sure your bot has enough Stars in its balance before starting a large broadcast. You can check and top up the balance via [@BotFather](https://t.me/BotFather).

### Simple approach: loop with delay

Use the [built-in `withRetries` function](/bot-api#Handling-Rate-Limit) which catches `retry_after` errors, waits the specified time, and retries the request automatically. Combine it with a base delay between each request to stay under the limit:

```ts twoslash
// experimental API available since Node.js@16.14.0
import { scheduler } from "node:timers/promises";
import { Bot, TelegramError } from "gramio";
import { withRetries } from "gramio/utils";

const bot = new Bot(process.env.BOT_TOKEN as string);
const chatIds: number[] = [
    /** some chat ids */
];

for (const chatId of chatIds) {
    const result = await withRetries(() =>
        bot.api.sendMessage({
            suppress: true,
            chat_id: chatId,
            text: "Hi!",
        })
    );

    await scheduler.wait(100); // Base delay between successful requests to avoid rate limits
}
```

This is a good starting point for small broadcasts (up to a few thousand users). But it has downsides:

* **Not persistent** — if the server restarts, you lose your position in the list
* **Not scalable** — a single loop can't be parallelized across multiple servers
* **No progress tracking** — you don't know which users have already received the message

### Production-ready: @gramio/broadcast

For real-world broadcasting, use [@gramio/broadcast](https://github.com/gramiojs/broadcast) — a queue-based solution built into the GramIO ecosystem. It's **persistent** (survives restarts), **horizontally scalable**, and handles rate limiting automatically.

**Requirements:** [Redis](https://redis.io/)

```ts
import { Bot, InlineKeyboard } from "gramio";
import Redis from "ioredis";
import { Broadcast } from "@gramio/broadcast";

const redis = new Redis({
    maxRetriesPerRequest: null,
});

const bot = new Bot(process.env.BOT_TOKEN as string);

const broadcast = new Broadcast(redis).type("test", (chatId: number) =>
    bot.api.sendMessage({
        chat_id: chatId,
        text: "test",
    })
);

console.log("prepared to start");

const chatIds = [617580375];

await broadcast.start(
    "test",
    chatIds.map((x) => [x])
);

// graceful shutdown
async function gracefulShutdown() {
    console.log(`Process ${process.pid} go to sleep`);

    await broadcast.job.queue.close();

    console.log("closed");
    process.exit(0);
}

process.on("SIGTERM", gracefulShutdown);

process.on("SIGINT", gracefulShutdown);
```

You define broadcast **types** with full type safety — each type specifies what data the broadcast function receives. Then call `broadcast.start` with an array of arguments and the library handles queuing, rate limiting, retries, and persistence.

### Custom implementation with BullMQ

If you need full control over the queue behavior, you can build your own solution using [BullMQ](https://docs.bullmq.io/) with [jobify](https://github.com/kravetsone/jobify):

**Requirements:** [Redis](https://redis.io/), ioredis, bullmq, [jobify](https://github.com/kravetsone/jobify)

```ts
import { Worker } from "bullmq";
import { Bot, TelegramError } from "gramio";
import { Redis } from "ioredis";
import { initJobify } from "jobify";

const bot = new Bot(process.env.BOT_TOKEN as string);

const redis = new Redis({
    maxRetriesPerRequest: null,
});

const defineJob = initJobify(redis);

const text = "Hello, world!";

const sendMailing = defineJob("send-mailing")
    .input<{ chatId: number }>()
    .options({
        limiter: {
            max: 20,
            duration: 1000,
        },
    })
    .action(async ({ data: { chatId } }) => {
        const response = await bot.api.sendMessage({
            chat_id: chatId,
            suppress: true,
            text,
        });

        if (response instanceof TelegramError) {
            if (response.payload?.retry_after) {
                await sendMailing.worker.rateLimit(
                    response.payload.retry_after * 1000
                );

                // use this only if you did not use auto-retry
                // because it re-run this job again
                throw Worker.RateLimitError();
            } else throw response;
        }
    });

const chats: number[] = []; // pick chats from database

await sendMailing.addBulk(
    chats.map((x) => ({
        name: "mailing",
        data: {
            chatId: x,
        },
    }))
);
```

The `limiter` option ensures BullMQ processes at most 20 jobs per second. If a 429 error occurs, the worker pauses for the time specified in `retry_after` and then resumes.

### Read also

* [So your bot is rate limited...](https://telegra.ph/So-your-bot-is-rate-limited-01-26)
* [Broadcasting to Users](https://core.telegram.org/bots/faq#broadcasting-to-users)

---

---
url: 'https://gramio.dev/plugins/official/i18n.md'
---

# I18n plugin

[![npm](https://img.shields.io/npm/v/@gramio/i18n?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/i18n)
[![JSR](https://jsr.io/badges/@gramio/i18n)](https://jsr.io/@gramio/i18n)
[![JSR Score](https://jsr.io/badges/@gramio/i18n/score)](https://jsr.io/@gramio/i18n)

`i18n` plugin for [GramIO](https://gramio.dev/).

This plugin provide internationalization for your bots with [Fluent](https://projectfluent.org/) syntax.

![example](https://github.com/gramiojs/i18n/assets/57632712/47e04c22-f442-4a5a-b8b9-15b8512f7c4b)

You can [setup type-safety](#type-safety) for it.

`i18n` plugin for [GramIO](https://gramio.dev/).

This plugin provide good way to add internationalization for your bots! It can be used without GramIO, but it will always keep it in mind.

> \[!IMPORTANT]
> Since `1.0.0`, we have two ways to write localization: [`I18n-in-TS`](#i18n-in-ts-syntax) and [`Fluent`](#fluent-syntax)

### Installation

For [I18n-in-TS syntax](#i18n-in-ts-syntax)

::: pm-add @gramio/i18n
:::

For [Fluent syntax](#fluent-syntax)

::: pm-add @gramio/i18n @fluent/bundle
:::

## I18n-in-TS syntax

This syntax allows you to write localization without leaving `.ts` files and does not require code-generation for **type-safety**, as well as provides convenient integration with the Format API out of the box!

```ts twoslash
import { format, Bot } from "gramio";
import {
    defineI18n,
    type LanguageMap,
    type ShouldFollowLanguage,
} from "@gramio/i18n";

const en = {
    greeting: (name: string) => format`Hello, ${name}!`,
    and: {
        some: {
            nested: "Hi!!!",
        },
    },
} satisfies LanguageMap;

const ru = {
    greeting: (name: string) => format`Привет, ${name}!`,
    and: {
        some: {
            nested: "Hi!!!",
        },
    },
} satisfies ShouldFollowLanguage<typeof en>;

// Strict will show error on missing keys
// satisfies ShouldFollowLanguageStrict<typeof en>;

const i18n = defineI18n({
    primaryLanguage: "en",
    languages: {
        en,
        ru,
    },
});

i18n.t("en", "greeting", "World"); // Hello, World!
i18n.t("en", "and.some.nested"); // Hi!!!

const bot = new Bot(process.env.BOT_TOKEN as string)
    .derive("message", (context) => {
        // u can take language from database or whatever u want and bind it to context without loosing type-safety
        return {
            t: i18n.buildT(context.from?.languageCode),
        };
    })
    .on("message", (context) => {
        return context.send(
            context.t("greeting", context.from?.firstName ?? "World")
        );
    });
```

### Plurals

```ts
import { pluralizeEnglish, pluralizeRussian } from "@gramio/i18n";

const count = 5;

console.log(`You have ${count} ${pluralizeEnglish(count, "apple", "apples")}.`); // You have 5 apples.

console.log(
    `У вас ${count} ${pluralizeRussian(count, "яблоко", "яблока", "яблок")}.`
); // У вас 5 яблок.
```

`ExtractLanguages` helps you extract languages types from i18n instance.

```ts
type EnLocalization = ExtractLanguages<typeof i18n>["en"];
type EnLocalizationKeys = keyof ExtractLanguages<typeof i18n>["en"];

type EnGreetingArgs = ExtractArgsParams<EnLocalization["greeting"]>;
```

## [Fluent](https://projectfluent.org/) syntax

This plugin provide internationalization for your bots with [Fluent](https://projectfluent.org/) syntax.

![example](https://github.com/gramiojs/i18n/assets/57632712/47e04c22-f442-4a5a-b8b9-15b8512f7c4b)

You can [setup type-safety](#type-safety) for it.

## Usage

### Create `locales` folder with `en.ftl` file

```ftl
# Simple things are simple.
hello-user = Hello, {$userName}!

# Complex things are possible.
shared-photos =
    {$userName} {$photoCount ->
        [one] added a new photo
       *[other] added {$photoCount} new photos
    } to {$userGender ->
        [male] his stream
        [female] her stream
       *[other] their stream
    }.
```

> \[!IMPORTANT]
> Fluent language support extensions for [VSCode](https://marketplace.visualstudio.com/items?itemName=macabeus.vscode-fluent) and [WebStorm](https://plugins.jetbrains.com/plugin/18416-fluent-language)

### Use plugin

```ts
// @moduleResolution: NodeNext
// @module: NodeNext
// src/index.ts
import { Bot } from "gramio";
import { i18n } from "@gramio/i18n/fluent";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(i18n())
    .command("start", async (context) => {
        return context.send(
            context.t("shared-photos", {
                userName: "Anna",
                userGender: "female",
                photoCount: 3,
            })
        );
    })
    .onError(console.error)
    .onStart(console.log);

bot.start();
```

## Options

| Key            | Type   | Default   | Description                               |
| -------------- | ------ | --------- | ----------------------------------------- |
| defaultLocale? | string | "en"      | Default locale                            |
| directory?     | string | "locales" | The path to the folder with `*.ftl` files |

##### Or provide an client

```ts twoslash
import { Bot } from "gramio";
import { getFluentClient, i18n } from "@gramio/i18n/fluent";

// or getFluentClient<TypedFluentBundle>()
const client = getFluentClient({
    defaultLocale: "en",
    directory: "locales",
});

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(i18n(client))
    .command("start", async (context) => {
        return context.send(context.t("hello-user", { userName: "Anna" }));
    });
```

> \[!IMPORTANT]
> See [Type-safety](#type-safety). You should provide generic to `getFluentClient` to get type-safety.

### Methods

#### t

Using this method, you can get the text in your chosen language.

For example:

```ftl
hello-user = Hello, {$userName}!
```

```ts
context.t("hello-user", { userName: "Anna" }); // Hello, Anna!
```

#### setLocale

You can set user locale by `setLocale` method.

> \[!WARNING]
> At the moment, there is no integration with sessions, and therefore, after the message, the language will again become the one that defaultLocale

```ts
bot.command("start", async (context) => {
    context.setLocale("ru");

    return context.send(
        context.t("shared-photos", {
            userName: "Anna",
            userGender: "female",
            photoCount: 3,
        })
    );
});
```

## Type-safety

You can use this plugin with [fluent2ts](https://github.com/kravetsone/fluent2ts) which code-generates typescript types from your `.ftl` files.
See [usage](https://github.com/kravetsone/fluent2ts?tab=readme-ov-file#usage).

::: pm-dlx fluent2ts
:::

And so we have a generated `locales.types.ts` file in `src` folder that exports the `TypedFluentBundle` interface.
We set this type as a **generic** for the `i18n` plugin. And now we have **type-safety**!

```ts twoslash
// @filename: locales.types.ts
import type {
    FluentBundle,
    FluentVariable,
    Message as FluentMessage,
} from "@fluent/bundle";

export interface LocalesMap {
    "hello-user": never;
    "shared-photos": {
        userName: FluentVariable;
        photoCount: FluentVariable;
        userGender: FluentVariable;
    };
}

export interface Message<Key extends keyof LocalesMap> extends FluentMessage {
    id: Key;
}

export interface TypedFluentBundle extends FluentBundle {
    getMessage<Key extends keyof LocalesMap>(key: Key): Message<Key>;
    formatPattern<Key extends keyof LocalesMap>(
        key: Key,
        ...args: LocalesMap[Key] extends never ? [] : [args: LocalesMap[Key]]
    ): string;
    formatPattern<Key extends keyof LocalesMap>(
        key: Key,
        args: LocalesMap[Key] extends never ? null : LocalesMap[Key],
        errors?: Error[] | null
    ): string;
}
// @filename: index.ts
// @errors: 2554
// @moduleResolution: NodeNext
// @module: NodeNext
// ---cut---
import type { TypedFluentBundle } from "./locales.types.js";
import { Bot } from "gramio";
import { i18n } from "@gramio/i18n/fluent";

const bot = new Bot(process.env.BOT_TOKEN as string)
    // or .extend(i18n(createFluentClient<TypedFluentBundle>()))
    .extend(i18n<TypedFluentBundle>())
    .command("start", async (context) => {
        const firstMsg = context.t("hello-user");
        //
        //
        //

        const secondMsg = context.t("shared-photos", {
            //                     ^?
            userName: "Anna",
            userGender: "female",
            photoCount: 3,
        });
        //
        //
        //
        //

        return context.send(secondMsg);
    })
    .onError(console.error)
    .onStart(console.log);

bot.start();
```

---

---
url: 'https://gramio.dev/tma/init-data.md'
---
# Init data

`@gramio/init-data` is a TypeScript library for securely validating, parsing, and generating Telegram Web App init data strings. It provides a set of utilities to help you work with the Telegram Mini App authentication init data, ensuring the integrity and authenticity of user data passed from the Telegram client to your backend. The library is framework-agnostic.

Key features:

* Validates the authenticity of Telegram Web App init data using your bot token
* Parses and exposes structured user and chat data from the init data string
* Generates valid init data strings for testing and documentation
* Provides strong TypeScript types for all data structures and methods

[Reference](https://jsr.io/@gramio/init-data@0.0.1/doc)

### Installation

::: pm-add @gramio/init-data
:::

# getBotTokenSecretKey

Get a secret key from your Telegram bot token. This secret key is required to validate the hash of the init data string sent by the Telegram Web App. Always use this method to generate the secret key before validating or signing init data if you wants reach maximum performance. If you don't provide it to validate init data methods it will execute it on **every call**.

```ts
import { getBotTokenSecretKey } from "@gramio/init-data";

const botToken = process.env.BOT_TOKEN as string;
const secretKey = getBotTokenSecretKey(botToken);
// use it later
```

# validateAndParseInitData

Verifies the authenticity of the Telegram Web App init data string using the secret key or bot token. If the data is valid, it parses and returns the [WebAppInitData](https://core.telegram.org/bots/webapps#webappinitdata) object. If the data is invalid, it returns `false`.

```ts
import {
    validateAndParseInitData,
    getBotTokenSecretKey,
} from "@gramio/init-data";

const botToken = process.env.BOT_TOKEN as string;
const secretKey = getBotTokenSecretKey(botToken);

const initData = req.headers["x-init-data"] as string;
const result = validateAndParseInitData(initData, secretKey);

if (!result) {
    // Handle invalid or tampered data
}

// Access user and chat data
const userId = result.user?.id;
const chatId = result.chat?.id;
```

# validateInitData

Checks the authenticity of the Telegram Web App init data string using the secret key or bot token. Returns `true` if the data is valid, otherwise returns `false`. This method only validates the data and does **not parse** it. Use this when you only need to check authenticity without extracting user or chat information.

```ts
import { validateInitData, getBotTokenSecretKey } from "@gramio/init-data";

const botToken = process.env.BOT_TOKEN as string;
const secretKey = getBotTokenSecretKey(botToken);

const initData = req.headers["x-init-data"] as string;
const isValid = validateInitData(initData, secretKey);

if (!isValid) {
    // Handle invalid or tampered data
}
// If valid, you can safely trust the init data string
```

# parseInitData

Parses the Telegram Web App init data string and returns the [WebAppInitData](https://core.telegram.org/bots/webapps#webappinitdata) object. This method does not perform any validation or authenticity checks. Use it only if you have already verified the data with `validateInitData` or `validateAndParseInitData`.

```ts
import { parseInitData } from "@gramio/init-data";

const initData = req.headers["x-init-data"] as string;
const parsed = parseInitData(initData);

// Access user and chat data
const userId = parsed.user?.id;
const chatId = parsed.chat?.id;
```

# signInitData

Generates a valid init data string from a data object and a secret key or bot token. This is useful for testing, documentation, or generating example values for API clients.

```ts
import {
    signInitData,
    getBotTokenSecretKey,
    type WebAppUser,
} from "@gramio/init-data";

const botToken = process.env.BOT_TOKEN as string;
const secretKey = getBotTokenSecretKey(botToken);

const data = {
    user: {
        id: 1,
        first_name: "durov",
        username: "durov",
    },
} satisfies WebAppUser;

const signedInitData = signInitData(data, secretKey);
// Use signedInitData as a valid init data string for testing
```

# Example: Elysia integration

You can use `@gramio/init-data` in any backend framework. Here is a bonus example of integrating it with Elysia for type-safe authentication:

```ts
twoslash;
import {
    validateAndParseInitData,
    signInitData,
    getBotTokenSecretKey,
} from "@gramio/init-data";
import { Elysia, t } from "elysia";

const secretKey = getBotTokenSecretKey(process.env.BOT_TOKEN as string);

export const authElysia = new Elysia({
    name: "auth",
})
    .guard({
        headers: t.Object({
            "x-init-data": t.String({
                examples: [
                    signInitData(
                        {
                            user: {
                                id: 1,
                                first_name: "durov",
                                username: "durov",
                            },
                        },
                        secretKey
                    ),
                ],
            }),
        }),
        response: {
            401: t.Literal("UNAUTHORIZED"),
        },
    })
    .resolve(({ headers, error }) => {
        const result = validateAndParseInitData(
            headers["x-init-data"],
            secretKey
        );
        if (!result || !result.user)
            return error("Unauthorized", "UNAUTHORIZED");

        return {
            tgId: result.user.id,
            user: result.user,
        };
    })
    .as("plugin");

const app = new Elysia()
    .get("hello", "world")
    .use(authElysia)
    .get("/user", ({ user }) => {
        user;
        // ^?
    });
```

---

---
url: 'https://gramio.dev/keyboards/inline-keyboard.md'
---

# Inline Keyboard

Inline Keyboard is attached to the message. Represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.

See also [API Reference](https://jsr.io/@gramio/keyboards/doc/~/InlineKeyboard) and [how to answer to clicks](/triggers/callback-query).

## Import

### With GramIO

```ts twoslash
import { InlineKeyboard } from "gramio";
```

### Without GramIO

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
```

## Buttons ([Documentation](https://core.telegram.org/bots/api/#inlinekeyboardbutton))

Buttons are methods that assemble a inline keyboard for you.

### text

Text button with data to be sent in a [callback query](https://core.telegram.org/bots/api/#callbackquery) to the bot when button is pressed, 1-64 bytes.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard().text("some text", "payload");
// or
new InlineKeyboard().text("some text", {
    json: "payload",
}); // it uses JSON.stringify
```

### url

HTTP or tg:// URL to be opened when the button is pressed. Links `tg://user?id=<user_id>` can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard().url("GitHub", "https://github.com/gramiojs/gramio");
```

### webApp

Description of the [Web App](https://core.telegram.org/bots/webapps) that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method [answerWebAppQuery](https://core.telegram.org/bots/api/#answerwebappquery). Available only in private chats between a user and the bot.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard().webApp("some text", "https://...");
```

### copy

Type of button that copies the specified text to the clipboard.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard().copy(
    "Copy me",
    "Welcome to Gboard clipboard, any text you copy will be saved here. Tap on a clip to paste it in the text box. Use the edit icon to pin, add or delete clips. Touch and hold a clip to pin it. Unpinned clips will be deleted after 1 hour.",
);
```

### login

This inline keyboard button used to automatically authorize a user. Serves as a great replacement for the [Telegram Login Widget](https://core.telegram.org/widgets/login) when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:

Telegram apps support these buttons as of [version 5.7](https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots).

Sample bot: [@discussbot](https://t.me/discussbot)

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard().login("some text", "https://...");
// or
new InlineKeyboard().login("some text", {
    url: "https://...",
    request_write_access: true,
});
```

More about options in [documentation](https://core.telegram.org/bots/api/#loginurl)

### pay

Send a [Pay button](https://core.telegram.org/bots/api/#payments).

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard().pay("5 coins");
```

> \[!WARNING]
> This type of button **must** always be the first button in the first row and can only be used in invoice messages.

### switchToChat

Pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field.

By default empty, in which case just the bot's username will be inserted.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard().switchToChat("Select chat");
// or
new InlineKeyboard().switchToChat("Select chat", "InlineQuery");
```

### switchToChosenChat

Pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard().switchToChosenChat("Select chat");
// or
new InlineKeyboard().switchToChosenChat("Select chat", "InlineQuery");
// or
new InlineKeyboard().switchToChosenChat("Select chat", {
    query: "InlineQuery",
    allow_channel_chats: true,
    allow_group_chats: true,
    allow_bot_chats: true,
    allow_user_chats: true,
});
```

More about options in [documentation](https://core.telegram.org/bots/api/#switchinlinequerychosenchat)

### switchToCurrentChat

Pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.

This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard().switchToCurrentChat("Open Inline mod");
// or
new InlineKeyboard().switchToCurrentChat("Open Inline mod", "InlineQuery");
```

### game

Description of the game that will be launched when the user presses the button.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard().game("text", {}); // ??? no params...
```

> \[!WARNING]
> This type of button **must** always be the first button in the first row.

## Button Styling

Since `@gramio/keyboards` **1.3.0**, every button method accepts an optional `options` parameter that allows you to customize the visual appearance of the button.

```ts
interface ButtonOptions {
    style?: "danger" | "primary" | "success";
    icon_custom_emoji_id?: string;
}
```

> \[!TIP]
> These properties are officially supported since Bot API 9.4.

* **style** — visual color style of the button. Can be `"danger"` (red), `"primary"` (blue), or `"success"` (green).
* **icon\_custom\_emoji\_id** — custom emoji identifier to be shown alongside the button text.

The `options` parameter is always the **last** argument of any button method:

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard()
    .text("Delete", "delete_action", { style: "danger" })
    .text("Confirm", "confirm_action", {
        style: "success",
        icon_custom_emoji_id: "5368324170671202286",
    });
```

It also works with static methods:

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
InlineKeyboard.text("Cancel", "cancel", { style: "danger" });
InlineKeyboard.url("Open", "https://gramio.dev", { style: "primary" });
```

![button styling preview](/keyboards/styling.png)

## Helpers

Methods that help you build a keyboard.

### row

Adds a `line break`. Call this method to make sure that the next added buttons will be on a new row.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard()
    .text("first row", "payload")
    .row()
    .text("second row", "payload");
```

### columns

Allows you to limit the number of columns in the keyboard.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard()
    .columns(1)
    .text("first row", "payload")
    .text("second row", "payload")
    .text("third row", "payload");
```

### wrap

A custom handler that controls row wrapping.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard()
    .wrap(({ button }) => button.callback_data === "2")
    .text("first row", "1")
    .text("first row", "1")
    .text("second row", "2");
```

handler is

```ts
(options: { button: T; index: number; row: T[]; rowIndex: number }) => boolean;
```

### pattern

An array with the number of columns per row. Allows you to set a «template».

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard()
    .pattern([1, 3, 2])
    .text("1", "payload")
    .text("2", "payload")
    .text("2", "payload")
    .text("2", "payload")
    .text("3", "payload")
    .text("3", "payload");
```

### filter

A handler that helps filter keyboard buttons.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard()
    .filter(({ button }) => button.callback_data !== "hidden")
    .text("button", "pass")
    .text("button", "hidden")
    .text("button", "pass");
```

### add

Allows you to add multiple buttons in *raw* format.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
const labels = ["some", "buttons"];

new InlineKeyboard()
    .add({ text: "raw button", callback_data: "payload" })
    .add(InlineKeyboard.text("raw button by InlineKeyboard.text", "payload"))
    .add(...labels.map((x) => InlineKeyboard.text(x, `${x}payload`)));
```

### addIf

Allows you to dynamically substitute buttons depending on something.

```ts twoslash
// @noErrors
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
const labels = ["some", "buttons"];
const isAdmin = true;

new InlineKeyboard()
    .addIf(1 === 2, { text: "raw button", callback_data: "payload" })
    .addIf(
        isAdmin,
        InlineKeyboard.text("raw button by InlineKeyboard.text", "payload"),
    )
    .addIf(
        ({ index, rowIndex }) => rowIndex === index,
        ...labels.map((x) => InlineKeyboard.text(x, `${x}payload`)),
    );
```

### matrix

Allows you to create a button matrix.

```ts twoslash
// @noErrors
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
import { randomInt } from "node:crypto";

const bomb = [randomInt(0, 9), randomInt(0, 9)] as const;

new InlineKeyboard().matrix(10, 10, ({ rowIndex, index }) =>
    InlineKeyboard.text(
        rowIndex === bomb[0] && index === bomb[1] ? "💣" : "ㅤ",
        "payload",
    ),
);
```

The result is keyboard with a bomb on a random button

handler is

```ts
(options: { index: number; rowIndex: number }) => T;
```

### combine

Allows you to combine keyboards. Only keyboards are combined. You need to call the `.row()` method to line-break after combine.

```ts twoslash
import { InlineKeyboard } from "@gramio/keyboards";
// ---cut---
new InlineKeyboard()
    .combine(new InlineKeyboard().text("first row", "payload"))
    .row()
    .combine(
        new InlineKeyboard()
            .text("second row", "payload")
            .row()
            .text("third row", "payload"),
    );
```

---

---
url: 'https://gramio.dev/triggers/inline-query.md'
---

# inlineQuery

The `inlineQuery` method in GramIO allows your bot to respond to inline queries sent by users. An inline query is a special type of message where users can search for content from your bot by typing in the message input field without directly interacting with the bot.

![feature preview](https://core.telegram.org/file/464001466/10e4a/r4FKyQ7gw5g.134366/f2606a53d683374703)

[Telegram documentation](https://core.telegram.org/bots/inline)

> \[!WARNING]
> You should enable this options via [@BotFather](https://telegram.me/botfather). Send the `/setinline` command, select the bot and provide the placeholder text that the user will see in the input field after typing your bot's name.

## Basic Usage

### Responding to an Inline Query with a Regular Expression

You can make your bot listen for specific inline queries that match a regular expression and respond with results. Here's an example:

```ts
bot.inlineQuery(/find (.*)/i, async (context) => {
    if (context.args) {
        await context.answer([
            InlineQueryResult.article(
                "id-1",
                `Result for ${context.args.at(1)}`,
                InputMessageContent.text(
                    `This is a message result for ${context.args.at(1)} query`
                )
            ),
        ]);
    }
});
```

In this example:

* The bot listens for inline queries that match the pattern `search (.*)`.
* If a match is found, the bot extracts the search term and returns a list of inline query results.

> \[!TIP]
> `context.answer()` accepts [`answerInlineQuery`](/telegram/methods/answerInlineQuery) parameters as a second argument. The most notable is **`cache_time`** — how long Telegram caches results on its servers (default **300 s**). Pass `cache_time: 0` for dynamic results that change with every keystroke — and especially during development.

### Parameters

* **`trigger`**: The condition that the inline query must meet. This can be a regular expression, a string, or a custom function.
  * **Regular Expression**: Matches queries that fit a specific pattern.
  * **String**: Matches an exact query string.
  * **Function**: Evaluates the query based on custom logic. Should return true to match.
* **`handler`**: The function that processes the inline query. It receives the `context` object, which includes details about the query and provides methods to respond.
* **`options`**: Additional options for handling the result selection.
  * **`onResult`**: A function that is triggered when the user selects an inline query result. It can be used to modify or update the message after selection. Use [ChosenInlineResult](/triggers/chosen-inline-result) under the hood.

> \[!IMPORTANT]
> You can modify only messages which contains InlineKeyboard. More about [ChosenInlineResult](/triggers/chosen-inline-result).

### How `inlineQuery` Works

1. **Query Matching**: When a user types an inline query, the `inlineQuery` method checks if the query matches the provided `trigger`. This can be a direct match (string), a pattern match (regular expression), or a condition check (function).

2. **Handling the Query**: If the query matches, the `handler` function is called. Inside this function, you can access the query parameters, generate results, and send them back to the user using `context.answer()`.

3. **Responding to Result Selection**: If the `onResult` option is provided, the bot listens for when a user selects one of the inline query results. The provided function can then modify the message, for example, by editing the text.

### Example: Custom Inline Query Handler

Here's a more detailed example that demonstrates using both the inline query trigger and handling result selection:

```ts
bot.inlineQuery(
    /find (.*)/i,
    async (context) => {
        if (context.args) {
            await context.answer(
                [
                    InlineQueryResult.article(
                        "result-1",
                        `Result for ${context.args[1]}`,
                        InputMessageContent.text(
                            `You searched for: ${context.args[1]}`
                        ),
                        {
                            reply_markup: new InlineKeyboard().text(
                                "Get Details",
                                "details-callback"
                            ),
                        }
                    ),
                ],
                {
                    cache_time: 0,
                }
            );
        }
    },
    {
        onResult: (context) => context.editText("You selected a result!"),
    }
);
```

In this example:

* The bot listens for inline queries that start with `find` followed by a search term.
* The bot responds with an inline query result that includes a button labeled "Get Details."
* When the user selects this result, the bot edits the message to indicate that a selection was made.

---

---
url: 'https://gramio.dev/api/gramio/interfaces/AddStickerToSetParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / AddStickerToSetParams

# Interface: AddStickerToSetParams

Defined in: @gramio/types/out/params.d.ts:3751

Params object for [addStickerToSet](APIMethods.md#addstickertoset) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `name` | `string` | Sticker set name | @gramio/types/out/params.d.ts:3759 |
|  `sticker` | [`TelegramInputSticker`](TelegramInputSticker.md) | A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed. | @gramio/types/out/params.d.ts:3763 |
|  `user_id` | `number` | User identifier of sticker set owner | @gramio/types/out/params.d.ts:3755 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/AnswerCallbackQueryParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / AnswerCallbackQueryParams

# Interface: AnswerCallbackQueryParams

Defined in: @gramio/types/out/params.d.ts:2451

Params object for [answerCallbackQuery](APIMethods.md#answercallbackquery) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `cache_time?` | `number` | The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0. | @gramio/types/out/params.d.ts:2473 |
|  `callback_query_id` | `string` | Unique identifier for the query to be answered | @gramio/types/out/params.d.ts:2455 |
|  `show_alert?` | `boolean` | If *True*, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to *false*. | @gramio/types/out/params.d.ts:2463 |
|  `text?` | `string` | Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters | @gramio/types/out/params.d.ts:2459 |
|  `url?` | `string` | URL that will be opened by the user's client. If you have created a [Game](https://core.telegram.org/bots/api#game) and accepted the conditions via [@BotFather](https://t.me/botfather), specify the URL that opens your game - note that this will only work if the query comes from a [*callback\_game*](https://core.telegram.org/bots/api#inlinekeyboardbutton) button. Otherwise, you may use links like `t.me/your_bot?start=XXXX` that open your bot with a parameter. | @gramio/types/out/params.d.ts:2469 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/AnswerInlineQueryParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / AnswerInlineQueryParams

# Interface: AnswerInlineQueryParams

Defined in: @gramio/types/out/params.d.ts:3919

Params object for [answerInlineQuery](APIMethods.md#answerinlinequery) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `button?` | [`TelegramInlineQueryResultsButton`](TelegramInlineQueryResultsButton.md) | A JSON-serialized object describing a button to be shown above inline query results | @gramio/types/out/params.d.ts:3943 |
|  `cache_time?` | `number` | The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. | @gramio/types/out/params.d.ts:3931 |
|  `inline_query_id` | `string` | Unique identifier for the answered query | @gramio/types/out/params.d.ts:3923 |
|  `is_personal?` | `boolean` | Pass *True* if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query. | @gramio/types/out/params.d.ts:3935 |
|  `next_offset?` | `string` | Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes. | @gramio/types/out/params.d.ts:3939 |
|  `results` | [`TelegramInlineQueryResult`](../type-aliases/TelegramInlineQueryResult.md)\[] | A JSON-serialized array of results for the inline query | @gramio/types/out/params.d.ts:3927 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/AnswerPreCheckoutQueryParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / AnswerPreCheckoutQueryParams

# Interface: AnswerPreCheckoutQueryParams

Defined in: @gramio/types/out/params.d.ts:4241

Params object for [answerPreCheckoutQuery](APIMethods.md#answerprecheckoutquery) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `error_message?` | `string` | Required if *ok* is *False*. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. | @gramio/types/out/params.d.ts:4253 |
|  `ok` | `boolean` | Specify *True* if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use *False* if there are any problems. | @gramio/types/out/params.d.ts:4249 |
|  `pre_checkout_query_id` | `string` | Unique identifier for the query to be answered | @gramio/types/out/params.d.ts:4245 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/AnswerShippingQueryParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / AnswerShippingQueryParams

# Interface: AnswerShippingQueryParams

Defined in: @gramio/types/out/params.d.ts:4219

Params object for [answerShippingQuery](APIMethods.md#answershippingquery) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `error_message?` | `string` | Required if *ok* is *False*. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user. | @gramio/types/out/params.d.ts:4235 |
|  `ok` | `boolean` | Pass *True* if delivery to the specified address is possible and *False* if there are any problems (for example, if delivery to the specified address is not possible) | @gramio/types/out/params.d.ts:4227 |
|  `shipping_options?` | [`TelegramShippingOption`](TelegramShippingOption.md)\[] | Required if *ok* is *True*. A JSON-serialized array of available shipping options. | @gramio/types/out/params.d.ts:4231 |
|  `shipping_query_id` | `string` | Unique identifier for the query to be answered | @gramio/types/out/params.d.ts:4223 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/AnswerWebAppQueryParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / AnswerWebAppQueryParams

# Interface: AnswerWebAppQueryParams

Defined in: @gramio/types/out/params.d.ts:3949

Params object for [answerWebAppQuery](APIMethods.md#answerwebappquery) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `result` | [`TelegramInlineQueryResult`](../type-aliases/TelegramInlineQueryResult.md) | A JSON-serialized object describing the message to be sent | @gramio/types/out/params.d.ts:3957 |
|  `web_app_query_id` | `string` | Unique identifier for the query to be answered | @gramio/types/out/params.d.ts:3953 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/APIMethods.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / APIMethods

# Interface: APIMethods

Defined in: @gramio/types/out/methods.d.ts:30

This object is a map of [API methods](https://core.telegram.org/bots/api#available-methods) types (functions map with input/output)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `addStickerToSet` | `CallAPI`<[`AddStickerToSetParams`](AddStickerToSetParams.md), `true`> | Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#addstickertoset) | @gramio/types/out/methods.d.ts:1040 |
|  `answerCallbackQuery` | `CallAPI`<[`AnswerCallbackQueryParams`](AnswerCallbackQueryParams.md), `true`> | Use this method to send answers to callback queries sent from [inline keyboards](https://core.telegram.org/bots/features#inline-keyboards). The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, *True* is returned. > Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via [@BotFather](https://t.me/botfather) and accept the terms. Otherwise, you may use links like `t.me/your_bot?start=XXXX` that open your bot with a parameter. [Documentation](https://core.telegram.org/bots/api/#answercallbackquery) | @gramio/types/out/methods.d.ts:568 |
|  `answerInlineQuery` | `CallAPI`<[`AnswerInlineQueryParams`](AnswerInlineQueryParams.md), `true`> | Use this method to send answers to an inline query. On success, *True* is returned. No more than **50** results per query are allowed. [Documentation](https://core.telegram.org/bots/api/#answerinlinequery) | @gramio/types/out/methods.d.ts:1110 |
|  `answerPreCheckoutQuery` | `CallAPI`<[`AnswerPreCheckoutQueryParams`](AnswerPreCheckoutQueryParams.md), `true`> | Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an [Update](https://core.telegram.org/bots/api#update) with the field *pre\_checkout\_query*. Use this method to respond to such pre-checkout queries. On success, *True* is returned. **Note:** The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. [Documentation](https://core.telegram.org/bots/api/#answerprecheckoutquery) | @gramio/types/out/methods.d.ts:1152 |
|  `answerShippingQuery` | `CallAPI`<[`AnswerShippingQueryParams`](AnswerShippingQueryParams.md), `true`> | If you sent an invoice requesting a shipping address and the parameter *is\_flexible* was specified, the Bot API will send an [Update](https://core.telegram.org/bots/api#update) with a *shipping\_query* field to the bot. Use this method to reply to shipping queries. On success, *True* is returned. [Documentation](https://core.telegram.org/bots/api/#answershippingquery) | @gramio/types/out/methods.d.ts:1146 |
|  `answerWebAppQuery` | `CallAPI`<[`AnswerWebAppQueryParams`](AnswerWebAppQueryParams.md), [`TelegramSentWebAppMessage`](TelegramSentWebAppMessage.md)> | Use this method to set the result of an interaction with a [Web App](https://core.telegram.org/bots/webapps) and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a [SentWebAppMessage](https://core.telegram.org/bots/api#sentwebappmessage) object is returned. [Documentation](https://core.telegram.org/bots/api/#answerwebappquery) | @gramio/types/out/methods.d.ts:1116 |
|  `approveChatJoinRequest` | `CallAPI`<[`ApproveChatJoinRequestParams`](ApproveChatJoinRequestParams.md), `true`> | Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the *can\_invite\_users* administrator right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#approvechatjoinrequest) | @gramio/types/out/methods.d.ts:377 |
|  `approveSuggestedPost` | `CallAPI`<[`ApproveSuggestedPostParams`](ApproveSuggestedPostParams.md), `true`> | Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can\_post\_messages' administrator right in the corresponding channel chat. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#approvesuggestedpost) | @gramio/types/out/methods.d.ts:967 |
|  `banChatMember` | `CallAPI`<[`BanChatMemberParams`](BanChatMemberParams.md), `true`> | Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless [unbanned](https://core.telegram.org/bots/api#unbanchatmember) first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#banchatmember) | @gramio/types/out/methods.d.ts:269 |
|  `banChatSenderChat` | `CallAPI`<[`BanChatSenderChatParams`](BanChatSenderChatParams.md), `true`> | Use this method to ban a channel chat in a supergroup or a channel. Until the chat is [unbanned](https://core.telegram.org/bots/api#unbanchatsenderchat), the owner of the banned chat won't be able to send messages on behalf of **any of their channels**. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#banchatsenderchat) | @gramio/types/out/methods.d.ts:308 |
|  `close` | `CallAPIWithoutParams`<`true`> | Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns *True* on success. Requires no parameters. [Documentation](https://core.telegram.org/bots/api/#close) | @gramio/types/out/methods.d.ts:77 |
|  `closeForumTopic` | `CallAPI`<[`CloseForumTopicParams`](CloseForumTopicParams.md), `true`> | Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#closeforumtopic) | @gramio/types/out/methods.d.ts:500 |
|  `closeGeneralForumTopic` | `CallAPI`<[`CloseGeneralForumTopicParams`](CloseGeneralForumTopicParams.md), `true`> | Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#closegeneralforumtopic) | @gramio/types/out/methods.d.ts:533 |
|  `convertGiftToStars` | `CallAPI`<[`ConvertGiftToStarsParams`](ConvertGiftToStarsParams.md), `true`> | Converts a given regular gift to Telegram Stars. Requires the *can\_convert\_gifts\_to\_stars* business bot right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#convertgifttostars) | @gramio/types/out/methods.d.ts:856 |
|  `copyMessage` | `CallAPI`<[`CopyMessageParams`](CopyMessageParams.md), [`TelegramMessageId`](TelegramMessageId.md)> | Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz [poll](https://core.telegram.org/bots/api#poll) can be copied only if the value of the field *correct\_option\_id* is known to the bot. The method is analogous to the method [forwardMessage](https://core.telegram.org/bots/api#forwardmessage), but the copied message doesn't have a link to the original message. Returns the [MessageId](https://core.telegram.org/bots/api#messageid) of the sent message on success. [Documentation](https://core.telegram.org/bots/api/#copymessage) | @gramio/types/out/methods.d.ts:107 |
|  `copyMessages` | `CallAPI`<[`CopyMessagesParams`](CopyMessagesParams.md), [`TelegramMessageId`](TelegramMessageId.md)\[]> | Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz [poll](https://core.telegram.org/bots/api#poll) can be copied only if the value of the field *correct\_option\_id* is known to the bot. The method is analogous to the method [forwardMessages](https://core.telegram.org/bots/api#forwardmessages), but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of [MessageId](https://core.telegram.org/bots/api#messageid) of the sent messages is returned. [Documentation](https://core.telegram.org/bots/api/#copymessages) | @gramio/types/out/methods.d.ts:113 |
|  `createChatInviteLink` | `CallAPI`<[`CreateChatInviteLinkParams`](CreateChatInviteLinkParams.md), [`TelegramChatInviteLink`](TelegramChatInviteLink.md)> | Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method [revokeChatInviteLink](https://core.telegram.org/bots/api#revokechatinvitelink). Returns the new invite link as [ChatInviteLink](https://core.telegram.org/bots/api#chatinvitelink) object. [Documentation](https://core.telegram.org/bots/api/#createchatinvitelink) | @gramio/types/out/methods.d.ts:332 |
|  `createChatSubscriptionInviteLink` | `CallAPI`<[`CreateChatSubscriptionInviteLinkParams`](CreateChatSubscriptionInviteLinkParams.md), [`TelegramChatInviteLink`](TelegramChatInviteLink.md)> | Use this method to create a [subscription invite link](https://telegram.org/blog/superchannels-star-reactions-subscriptions#star-subscriptions) for a channel chat. The bot must have the *can\_invite\_users* administrator rights. The link can be edited using the method [editChatSubscriptionInviteLink](https://core.telegram.org/bots/api#editchatsubscriptioninvitelink) or revoked using the method [revokeChatInviteLink](https://core.telegram.org/bots/api#revokechatinvitelink). Returns the new invite link as a [ChatInviteLink](https://core.telegram.org/bots/api#chatinvitelink) object. [Documentation](https://core.telegram.org/bots/api/#createchatsubscriptioninvitelink) | @gramio/types/out/methods.d.ts:350 |
|  `createForumTopic` | `CallAPI`<[`CreateForumTopicParams`](CreateForumTopicParams.md), [`TelegramForumTopic`](TelegramForumTopic.md)> | Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator right. Returns information about the created topic as a [ForumTopic](https://core.telegram.org/bots/api#forumtopic) object. [Documentation](https://core.telegram.org/bots/api/#createforumtopic) | @gramio/types/out/methods.d.ts:485 |
|  `createInvoiceLink` | `CallAPI`<[`CreateInvoiceLinkParams`](CreateInvoiceLinkParams.md), `string`> | Use this method to create a link for an invoice. Returns the created invoice link as *String* on success. [Documentation](https://core.telegram.org/bots/api/#createinvoicelink) | @gramio/types/out/methods.d.ts:1140 |
|  `createNewStickerSet` | `CallAPI`<[`CreateNewStickerSetParams`](CreateNewStickerSetParams.md), `true`> | Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#createnewstickerset) | @gramio/types/out/methods.d.ts:1034 |
|  `declineChatJoinRequest` | `CallAPI`<[`DeclineChatJoinRequestParams`](DeclineChatJoinRequestParams.md), `true`> | Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the *can\_invite\_users* administrator right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#declinechatjoinrequest) | @gramio/types/out/methods.d.ts:383 |
|  `declineSuggestedPost` | `CallAPI`<[`DeclineSuggestedPostParams`](DeclineSuggestedPostParams.md), `true`> | Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can\_manage\_direct\_messages' administrator right in the corresponding channel chat. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#declinesuggestedpost) | @gramio/types/out/methods.d.ts:973 |
|  `deleteBusinessMessages` | `CallAPI`<[`DeleteBusinessMessagesParams`](DeleteBusinessMessagesParams.md), `true`> | Delete messages on behalf of a business account. Requires the *can\_delete\_sent\_messages* business bot right to delete messages sent by the bot itself, or the *can\_delete\_all\_messages* business bot right to delete any message. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#deletebusinessmessages) | @gramio/types/out/methods.d.ts:763 |
|  `deleteChatPhoto` | `CallAPI`<[`DeleteChatPhotoParams`](DeleteChatPhotoParams.md), `true`> | Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#deletechatphoto) | @gramio/types/out/methods.d.ts:395 |
|  `deleteChatStickerSet` | `CallAPI`<[`DeleteChatStickerSetParams`](DeleteChatStickerSetParams.md), `true`> | Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field *can\_set\_sticker\_set* optionally returned in [getChat](https://core.telegram.org/bots/api#getchat) requests to check if the bot can use this method. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#deletechatstickerset) | @gramio/types/out/methods.d.ts:473 |
|  `deleteForumTopic` | `CallAPI`<[`DeleteForumTopicParams`](DeleteForumTopicParams.md), `true`> | Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can\_delete\_messages* administrator rights. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#deleteforumtopic) | @gramio/types/out/methods.d.ts:512 |
|  `deleteMessage` | `CallAPI`<[`DeleteMessageParams`](DeleteMessageParams.md), `true`> | Use this method to delete a message, including service messages, with the following limitations: - A message can only be deleted if it was sent less than 48 hours ago. - Service messages about a supergroup, channel, or forum topic creation can't be deleted. - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. - Bots can delete outgoing messages in private chats, groups, and supergroups. - Bots can delete incoming messages in private chats. - Bots granted *can\_post\_messages* permissions can delete outgoing messages in channels. - If the bot is an administrator of a group, it can delete any message there. - If the bot has *can\_delete\_messages* administrator right in a supergroup or a channel, it can delete any message there. - If the bot has *can\_manage\_direct\_messages* administrator right in a channel, it can delete any message in the corresponding direct messages chat. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#deletemessage) | @gramio/types/out/methods.d.ts:989 |
|  `deleteMessages` | `CallAPI`<[`DeleteMessagesParams`](DeleteMessagesParams.md), `true`> | Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#deletemessages) | @gramio/types/out/methods.d.ts:995 |
|  `deleteMyCommands` | `CallAPIWithOptionalParams`<[`DeleteMyCommandsParams`](DeleteMyCommandsParams.md), `true`> | Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, [higher level commands](https://core.telegram.org/bots/api#determining-list-of-commands) will be shown to affected users. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#deletemycommands) | @gramio/types/out/methods.d.ts:598 |
|  `deleteStickerFromSet` | `CallAPI`<[`DeleteStickerFromSetParams`](DeleteStickerFromSetParams.md), `true`> | Use this method to delete a sticker from a set created by the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#deletestickerfromset) | @gramio/types/out/methods.d.ts:1052 |
|  `deleteStickerSet` | `CallAPI`<[`DeleteStickerSetParams`](DeleteStickerSetParams.md), `true`> | Use this method to delete a sticker set that was created by the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#deletestickerset) | @gramio/types/out/methods.d.ts:1103 |
|  `deleteStory` | `CallAPI`<[`DeleteStoryParams`](DeleteStoryParams.md), `true`> | Deletes a story previously posted by the bot on behalf of a managed business account. Requires the *can\_manage\_stories* business bot right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#deletestory) | @gramio/types/out/methods.d.ts:892 |
|  `deleteWebhook` | `CallAPIWithOptionalParams`<[`DeleteWebhookParams`](DeleteWebhookParams.md), `true`> | Use this method to remove webhook integration if you decide to switch back to [getUpdates](https://core.telegram.org/bots/api#getupdates). Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#deletewebhook) | @gramio/types/out/methods.d.ts:53 |
|  `editChatInviteLink` | `CallAPI`<[`EditChatInviteLinkParams`](EditChatInviteLinkParams.md), [`TelegramChatInviteLink`](TelegramChatInviteLink.md)> | Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a [ChatInviteLink](https://core.telegram.org/bots/api#chatinvitelink) object. [Documentation](https://core.telegram.org/bots/api/#editchatinvitelink) | @gramio/types/out/methods.d.ts:341 |
|  `editChatSubscriptionInviteLink` | `CallAPI`<[`EditChatSubscriptionInviteLinkParams`](EditChatSubscriptionInviteLinkParams.md), [`TelegramChatInviteLink`](TelegramChatInviteLink.md)> | Use this method to edit a subscription invite link created by the bot. The bot must have the *can\_invite\_users* administrator rights. Returns the edited invite link as a [ChatInviteLink](https://core.telegram.org/bots/api#chatinvitelink) object. [Documentation](https://core.telegram.org/bots/api/#editchatsubscriptioninvitelink) | @gramio/types/out/methods.d.ts:359 |
|  `editForumTopic` | `CallAPI`<[`EditForumTopicParams`](EditForumTopicParams.md), `true`> | Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#editforumtopic) | @gramio/types/out/methods.d.ts:494 |
|  `editGeneralForumTopic` | `CallAPI`<[`EditGeneralForumTopicParams`](EditGeneralForumTopicParams.md), `true`> | Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#editgeneralforumtopic) | @gramio/types/out/methods.d.ts:527 |
|  `editMessageCaption` | `CallAPIWithOptionalParams`<[`EditMessageCaptionParams`](EditMessageCaptionParams.md), `true` | [`TelegramMessage`](TelegramMessage.md)> | Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited [Message](https://core.telegram.org/bots/api#message) is returned, otherwise *True* is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. [Documentation](https://core.telegram.org/bots/api/#editmessagecaption) | @gramio/types/out/methods.d.ts:907 |
|  `editMessageChecklist` | `CallAPI`<[`EditMessageChecklistParams`](EditMessageChecklistParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to edit a checklist on behalf of a connected business account. On success, the edited [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#editmessagechecklist) | @gramio/types/out/methods.d.ts:943 |
|  `editMessageLiveLocation` | `CallAPI`<[`EditMessageLiveLocationParams`](EditMessageLiveLocationParams.md), `true` | [`TelegramMessage`](TelegramMessage.md)> | Use this method to edit live location messages. A location can be edited until its *live\_period* expires or editing is explicitly disabled by a call to [stopMessageLiveLocation](https://core.telegram.org/bots/api#stopmessagelivelocation). On success, if the edited message is not an inline message, the edited [Message](https://core.telegram.org/bots/api#message) is returned, otherwise *True* is returned. [Documentation](https://core.telegram.org/bots/api/#editmessagelivelocation) | @gramio/types/out/methods.d.ts:925 |
|  `editMessageMedia` | `CallAPI`<[`EditMessageMediaParams`](EditMessageMediaParams.md), `true` | [`TelegramMessage`](TelegramMessage.md)> | Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file\_id or specify a URL. On success, if the edited message is not an inline message, the edited [Message](https://core.telegram.org/bots/api#message) is returned, otherwise *True* is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. [Documentation](https://core.telegram.org/bots/api/#editmessagemedia) | @gramio/types/out/methods.d.ts:916 |
|  `editMessageReplyMarkup` | `CallAPIWithOptionalParams`<[`EditMessageReplyMarkupParams`](EditMessageReplyMarkupParams.md), `true` | [`TelegramMessage`](TelegramMessage.md)> | Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited [Message](https://core.telegram.org/bots/api#message) is returned, otherwise *True* is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. [Documentation](https://core.telegram.org/bots/api/#editmessagereplymarkup) | @gramio/types/out/methods.d.ts:952 |
|  `editMessageText` | `CallAPI`<[`EditMessageTextParams`](EditMessageTextParams.md), `true` | [`TelegramMessage`](TelegramMessage.md)> | Use this method to edit text and [game](https://core.telegram.org/bots/api#games) messages. On success, if the edited message is not an inline message, the edited [Message](https://core.telegram.org/bots/api#message) is returned, otherwise *True* is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. [Documentation](https://core.telegram.org/bots/api/#editmessagetext) | @gramio/types/out/methods.d.ts:898 |
|  `editStory` | `CallAPI`<[`EditStoryParams`](EditStoryParams.md), [`TelegramStory`](TelegramStory.md)> | Edits a story previously posted by the bot on behalf of a managed business account. Requires the *can\_manage\_stories* business bot right. Returns [Story](https://core.telegram.org/bots/api#story) on success. [Documentation](https://core.telegram.org/bots/api/#editstory) | @gramio/types/out/methods.d.ts:886 |
|  `editUserStarSubscription` | `CallAPI`<[`EditUserStarSubscriptionParams`](EditUserStarSubscriptionParams.md), `true`> | Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#edituserstarsubscription) | @gramio/types/out/methods.d.ts:1179 |
|  `exportChatInviteLink` | `CallAPI`<[`ExportChatInviteLinkParams`](ExportChatInviteLinkParams.md), `string`> | Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as *String* on success. [Documentation](https://core.telegram.org/bots/api/#exportchatinvitelink) | @gramio/types/out/methods.d.ts:326 |
|  `forwardMessage` | `CallAPI`<[`ForwardMessageParams`](ForwardMessageParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#forwardmessage) | @gramio/types/out/methods.d.ts:89 |
|  `forwardMessages` | `CallAPI`<[`ForwardMessagesParams`](ForwardMessagesParams.md), [`TelegramMessageId`](TelegramMessageId.md)\[]> | Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of [MessageId](https://core.telegram.org/bots/api#messageid) of the sent messages is returned. [Documentation](https://core.telegram.org/bots/api/#forwardmessages) | @gramio/types/out/methods.d.ts:98 |
|  `getAvailableGifts` | `CallAPIWithoutParams`<[`TelegramGifts`](TelegramGifts.md)> | Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a [Gifts](https://core.telegram.org/bots/api#gifts) object. [Documentation](https://core.telegram.org/bots/api/#getavailablegifts) | @gramio/types/out/methods.d.ts:715 |
|  `getBusinessAccountGifts` | `CallAPI`<[`GetBusinessAccountGiftsParams`](GetBusinessAccountGiftsParams.md), [`TelegramOwnedGifts`](TelegramOwnedGifts.md)> | Returns the gifts received and owned by a managed business account. Requires the *can\_view\_gifts\_and\_stars* business bot right. Returns [OwnedGifts](https://core.telegram.org/bots/api#ownedgifts) on success. [Documentation](https://core.telegram.org/bots/api/#getbusinessaccountgifts) | @gramio/types/out/methods.d.ts:835 |
|  `getBusinessAccountStarBalance` | `CallAPI`<[`GetBusinessAccountStarBalanceParams`](GetBusinessAccountStarBalanceParams.md), [`TelegramStarAmount`](TelegramStarAmount.md)> | Returns the amount of Telegram Stars owned by a managed business account. Requires the *can\_view\_gifts\_and\_stars* business bot right. Returns [StarAmount](https://core.telegram.org/bots/api#staramount) on success. [Documentation](https://core.telegram.org/bots/api/#getbusinessaccountstarbalance) | @gramio/types/out/methods.d.ts:817 |
|  `getBusinessConnection` | `CallAPI`<[`GetBusinessConnectionParams`](GetBusinessConnectionParams.md), [`TelegramBusinessConnection`](TelegramBusinessConnection.md)> | Use this method to get information about the connection of the bot with a business account. Returns a [BusinessConnection](https://core.telegram.org/bots/api#businessconnection) object on success. [Documentation](https://core.telegram.org/bots/api/#getbusinessconnection) | @gramio/types/out/methods.d.ts:583 |
|  `getChat` | `CallAPI`<[`GetChatParams`](GetChatParams.md), [`TelegramChatFullInfo`](TelegramChatFullInfo.md)> | Use this method to get up-to-date information about the chat. Returns a [ChatFullInfo](https://core.telegram.org/bots/api#chatfullinfo) object on success. [Documentation](https://core.telegram.org/bots/api/#getchat) | @gramio/types/out/methods.d.ts:437 |
|  `getChatAdministrators` | `CallAPI`<[`GetChatAdministratorsParams`](GetChatAdministratorsParams.md), [`TelegramChatMember`](../type-aliases/TelegramChatMember.md)\[]> | Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of [ChatMember](https://core.telegram.org/bots/api#chatmember) objects. [Documentation](https://core.telegram.org/bots/api/#getchatadministrators) | @gramio/types/out/methods.d.ts:443 |
|  `getChatGifts` | `CallAPI`<[`GetChatGiftsParams`](GetChatGiftsParams.md), [`TelegramOwnedGifts`](TelegramOwnedGifts.md)> | Returns the gifts owned by a chat. Returns [OwnedGifts](https://core.telegram.org/bots/api#ownedgifts) on success. [Documentation](https://core.telegram.org/bots/api/#getchatgifts) | @gramio/types/out/methods.d.ts:850 |
|  `getChatMember` | `CallAPI`<[`GetChatMemberParams`](GetChatMemberParams.md), [`TelegramChatMember`](../type-aliases/TelegramChatMember.md)> | Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a [ChatMember](https://core.telegram.org/bots/api#chatmember) object on success. [Documentation](https://core.telegram.org/bots/api/#getchatmember) | @gramio/types/out/methods.d.ts:458 |
|  `getChatMemberCount` | `CallAPI`<[`GetChatMemberCountParams`](GetChatMemberCountParams.md), `number`> | Use this method to get the number of members in a chat. Returns *Int* on success. [Documentation](https://core.telegram.org/bots/api/#getchatmembercount) | @gramio/types/out/methods.d.ts:452 |
|  `getChatMenuButton` | `CallAPIWithOptionalParams`<[`GetChatMenuButtonParams`](GetChatMenuButtonParams.md), [`TelegramMenuButton`](../type-aliases/TelegramMenuButton.md)> | Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns [MenuButton](https://core.telegram.org/bots/api#menubutton) on success. [Documentation](https://core.telegram.org/bots/api/#getchatmenubutton) | @gramio/types/out/methods.d.ts:688 |
|  `getCustomEmojiStickers` | `CallAPI`<[`GetCustomEmojiStickersParams`](GetCustomEmojiStickersParams.md), [`TelegramSticker`](TelegramSticker.md)\[]> | Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of [Sticker](https://core.telegram.org/bots/api#sticker) objects. [Documentation](https://core.telegram.org/bots/api/#getcustomemojistickers) | @gramio/types/out/methods.d.ts:1016 |
|  `getFile` | `CallAPI`<[`GetFileParams`](GetFileParams.md), [`TelegramFile`](TelegramFile.md)> | Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a [File](https://core.telegram.org/bots/api#file) object is returned. The file can then be downloaded via the link `https://api.telegram.org/file/bot<token>/<file_path>`, where `<file_path>` is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling [getFile](https://core.telegram.org/bots/api#getfile) again. [Documentation](https://core.telegram.org/bots/api/#getfile) | @gramio/types/out/methods.d.ts:263 |
|  `getForumTopicIconStickers` | `CallAPIWithoutParams`<[`TelegramSticker`](TelegramSticker.md)\[]> | Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of [Sticker](https://core.telegram.org/bots/api#sticker) objects. [Documentation](https://core.telegram.org/bots/api/#getforumtopiciconstickers) | @gramio/types/out/methods.d.ts:479 |
|  `getGameHighScores` | `CallAPI`<[`GetGameHighScoresParams`](GetGameHighScoresParams.md), [`TelegramGameHighScore`](TelegramGameHighScore.md)\[]> | Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of [GameHighScore](https://core.telegram.org/bots/api#gamehighscore) objects. > This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change. [Documentation](https://core.telegram.org/bots/api/#getgamehighscores) | @gramio/types/out/methods.d.ts:1213 |
|  `getMe` | `CallAPIWithoutParams`<[`TelegramUser`](TelegramUser.md)> | A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a [User](https://core.telegram.org/bots/api#user) object. [Documentation](https://core.telegram.org/bots/api/#getme) | @gramio/types/out/methods.d.ts:65 |
|  `getMyCommands` | `CallAPIWithOptionalParams`<[`GetMyCommandsParams`](GetMyCommandsParams.md), [`TelegramBotCommand`](TelegramBotCommand.md)\[]> | Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of [BotCommand](https://core.telegram.org/bots/api#botcommand) objects. If commands aren't set, an empty list is returned. [Documentation](https://core.telegram.org/bots/api/#getmycommands) | @gramio/types/out/methods.d.ts:607 |
|  `getMyDefaultAdministratorRights` | `CallAPIWithOptionalParams`<[`GetMyDefaultAdministratorRightsParams`](GetMyDefaultAdministratorRightsParams.md), [`TelegramChatAdministratorRights`](TelegramChatAdministratorRights.md)> | Use this method to get the current default administrator rights of the bot. Returns [ChatAdministratorRights](https://core.telegram.org/bots/api#chatadministratorrights) on success. [Documentation](https://core.telegram.org/bots/api/#getmydefaultadministratorrights) | @gramio/types/out/methods.d.ts:706 |
|  `getMyDescription` | `CallAPIWithOptionalParams`<[`GetMyDescriptionParams`](GetMyDescriptionParams.md), [`TelegramBotDescription`](TelegramBotDescription.md)> | Use this method to get the current bot description for the given user language. Returns [BotDescription](https://core.telegram.org/bots/api#botdescription) on success. [Documentation](https://core.telegram.org/bots/api/#getmydescription) | @gramio/types/out/methods.d.ts:640 |
|  `getMyName` | `CallAPIWithOptionalParams`<[`GetMyNameParams`](GetMyNameParams.md), [`TelegramBotName`](TelegramBotName.md)> | Use this method to get the current bot name for the given user language. Returns [BotName](https://core.telegram.org/bots/api#botname) on success. [Documentation](https://core.telegram.org/bots/api/#getmyname) | @gramio/types/out/methods.d.ts:622 |
|  `getMyShortDescription` | `CallAPIWithOptionalParams`<[`GetMyShortDescriptionParams`](GetMyShortDescriptionParams.md), [`TelegramBotShortDescription`](TelegramBotShortDescription.md)> | Use this method to get the current bot short description for the given user language. Returns [BotShortDescription](https://core.telegram.org/bots/api#botshortdescription) on success. [Documentation](https://core.telegram.org/bots/api/#getmyshortdescription) | @gramio/types/out/methods.d.ts:658 |
|  `getMyStarBalance` | `CallAPIWithoutParams`<[`TelegramStarAmount`](TelegramStarAmount.md)> | A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a [StarAmount](https://core.telegram.org/bots/api#staramount) object. [Documentation](https://core.telegram.org/bots/api/#getmystarbalance) | @gramio/types/out/methods.d.ts:1158 |
|  `getStarTransactions` | `CallAPIWithOptionalParams`<[`GetStarTransactionsParams`](GetStarTransactionsParams.md), [`TelegramStarTransactions`](TelegramStarTransactions.md)> | Returns the bot's Telegram Star transactions in chronological order. On success, returns a [StarTransactions](https://core.telegram.org/bots/api#startransactions) object. [Documentation](https://core.telegram.org/bots/api/#getstartransactions) | @gramio/types/out/methods.d.ts:1164 |
|  `getStickerSet` | `CallAPI`<[`GetStickerSetParams`](GetStickerSetParams.md), [`TelegramStickerSet`](TelegramStickerSet.md)> | Use this method to get a sticker set. On success, a [StickerSet](https://core.telegram.org/bots/api#stickerset) object is returned. [Documentation](https://core.telegram.org/bots/api/#getstickerset) | @gramio/types/out/methods.d.ts:1007 |
|  `getUpdates` | `CallAPIWithOptionalParams`<[`GetUpdatesParams`](GetUpdatesParams.md), [`TelegramUpdate`](TelegramUpdate.md)\[]> | Use this method to receive incoming updates using long polling ([wiki](https://en.wikipedia.org/wiki/Push_technology#Long_polling)). Returns an Array of [Update](https://core.telegram.org/bots/api#update) objects. [Documentation](https://core.telegram.org/bots/api/#getupdates) | @gramio/types/out/methods.d.ts:36 |
|  `getUserChatBoosts` | `CallAPI`<[`GetUserChatBoostsParams`](GetUserChatBoostsParams.md), [`TelegramUserChatBoosts`](TelegramUserChatBoosts.md)> | Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a [UserChatBoosts](https://core.telegram.org/bots/api#userchatboosts) object. [Documentation](https://core.telegram.org/bots/api/#getuserchatboosts) | @gramio/types/out/methods.d.ts:574 |
|  `getUserGifts` | `CallAPI`<[`GetUserGiftsParams`](GetUserGiftsParams.md), [`TelegramOwnedGifts`](TelegramOwnedGifts.md)> | Returns the gifts owned and hosted by a user. Returns [OwnedGifts](https://core.telegram.org/bots/api#ownedgifts) on success. [Documentation](https://core.telegram.org/bots/api/#getusergifts) | @gramio/types/out/methods.d.ts:844 |
|  `getUserProfileAudios` | `CallAPI`<[`GetUserProfileAudiosParams`](GetUserProfileAudiosParams.md), [`TelegramUserProfileAudios`](TelegramUserProfileAudios.md)> | Use this method to get a list of profile audios for a user. Returns a [UserProfileAudios](https://core.telegram.org/bots/api#userprofileaudios) object. [Documentation](https://core.telegram.org/bots/api/#getuserprofileaudios) | @gramio/types/out/methods.d.ts:248 |
|  `getUserProfilePhotos` | `CallAPI`<[`GetUserProfilePhotosParams`](GetUserProfilePhotosParams.md), [`TelegramUserProfilePhotos`](TelegramUserProfilePhotos.md)> | Use this method to get a list of profile pictures for a user. Returns a [UserProfilePhotos](https://core.telegram.org/bots/api#userprofilephotos) object. [Documentation](https://core.telegram.org/bots/api/#getuserprofilephotos) | @gramio/types/out/methods.d.ts:239 |
|  `getWebhookInfo` | `CallAPIWithoutParams`<[`TelegramWebhookInfo`](TelegramWebhookInfo.md)> | Use this method to get current webhook status. Requires no parameters. On success, returns a [WebhookInfo](https://core.telegram.org/bots/api#webhookinfo) object. If the bot is using [getUpdates](https://core.telegram.org/bots/api#getupdates), will return an object with the *url* field empty. [Documentation](https://core.telegram.org/bots/api/#getwebhookinfo) | @gramio/types/out/methods.d.ts:59 |
|  `giftPremiumSubscription` | `CallAPI`<[`GiftPremiumSubscriptionParams`](GiftPremiumSubscriptionParams.md), `true`> | Gifts a Telegram Premium subscription to the given user. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#giftpremiumsubscription) | @gramio/types/out/methods.d.ts:727 |
|  `hideGeneralForumTopic` | `CallAPI`<[`HideGeneralForumTopicParams`](HideGeneralForumTopicParams.md), `true`> | Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights. The topic will be automatically closed if it was open. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#hidegeneralforumtopic) | @gramio/types/out/methods.d.ts:545 |
|  `leaveChat` | `CallAPI`<[`LeaveChatParams`](LeaveChatParams.md), `true`> | Use this method for your bot to leave a group, supergroup or channel. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#leavechat) | @gramio/types/out/methods.d.ts:431 |
|  `logOut` | `CallAPIWithoutParams`<`true`> | Use this method to log out from the cloud Bot API server before launching the bot locally. You **must** log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns *True* on success. Requires no parameters. [Documentation](https://core.telegram.org/bots/api/#logout) | @gramio/types/out/methods.d.ts:71 |
|  `pinChatMessage` | `CallAPI`<[`PinChatMessageParams`](PinChatMessageParams.md), `true`> | Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can\_pin\_messages' right or the 'can\_edit\_messages' right to pin messages in groups and channels respectively. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#pinchatmessage) | @gramio/types/out/methods.d.ts:413 |
|  `postStory` | `CallAPI`<[`PostStoryParams`](PostStoryParams.md), [`TelegramStory`](TelegramStory.md)> | Posts a story on behalf of a managed business account. Requires the *can\_manage\_stories* business bot right. Returns [Story](https://core.telegram.org/bots/api#story) on success. [Documentation](https://core.telegram.org/bots/api/#poststory) | @gramio/types/out/methods.d.ts:874 |
|  `promoteChatMember` | `CallAPI`<[`PromoteChatMemberParams`](PromoteChatMemberParams.md), `true`> | Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass *False* for all boolean parameters to demote a user. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#promotechatmember) | @gramio/types/out/methods.d.ts:287 |
|  `readBusinessMessage` | `CallAPI`<[`ReadBusinessMessageParams`](ReadBusinessMessageParams.md), `true`> | Marks incoming message as read on behalf of a business account. Requires the *can\_read\_messages* business bot right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#readbusinessmessage) | @gramio/types/out/methods.d.ts:757 |
|  `refundStarPayment` | `CallAPI`<[`RefundStarPaymentParams`](RefundStarPaymentParams.md), `true`> | Refunds a successful payment in [Telegram Stars](https://t.me/BotNews/90). Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#refundstarpayment) | @gramio/types/out/methods.d.ts:1173 |
|  `removeBusinessAccountProfilePhoto` | `CallAPI`<[`RemoveBusinessAccountProfilePhotoParams`](RemoveBusinessAccountProfilePhotoParams.md), `true`> | Removes the current profile photo of a managed business account. Requires the *can\_edit\_profile\_photo* business bot right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#removebusinessaccountprofilephoto) | @gramio/types/out/methods.d.ts:799 |
|  `removeChatVerification` | `CallAPI`<[`RemoveChatVerificationParams`](RemoveChatVerificationParams.md), `true`> | Removes verification from a chat that is currently verified [on behalf of the organization](https://telegram.org/verify#third-party-verification) represented by the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#removechatverification) | @gramio/types/out/methods.d.ts:751 |
|  `removeMyProfilePhoto` | `CallAPIWithoutParams`<`true`> | Removes the profile photo of the bot. Requires no parameters. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#removemyprofilephoto) | @gramio/types/out/methods.d.ts:673 |
|  `removeUserVerification` | `CallAPI`<[`RemoveUserVerificationParams`](RemoveUserVerificationParams.md), `true`> | Removes verification from a user who is currently verified [on behalf of the organization](https://telegram.org/verify#third-party-verification) represented by the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#removeuserverification) | @gramio/types/out/methods.d.ts:745 |
|  `reopenForumTopic` | `CallAPI`<[`ReopenForumTopicParams`](ReopenForumTopicParams.md), `true`> | Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#reopenforumtopic) | @gramio/types/out/methods.d.ts:506 |
|  `reopenGeneralForumTopic` | `CallAPI`<[`ReopenGeneralForumTopicParams`](ReopenGeneralForumTopicParams.md), `true`> | Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights. The topic will be automatically unhidden if it was hidden. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#reopengeneralforumtopic) | @gramio/types/out/methods.d.ts:539 |
|  `replaceStickerInSet` | `CallAPI`<[`ReplaceStickerInSetParams`](ReplaceStickerInSetParams.md), `true`> | Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling [deleteStickerFromSet](https://core.telegram.org/bots/api#deletestickerfromset), then [addStickerToSet](https://core.telegram.org/bots/api#addstickertoset), then [setStickerPositionInSet](https://core.telegram.org/bots/api#setstickerpositioninset). Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#replacestickerinset) | @gramio/types/out/methods.d.ts:1058 |
|  `repostStory` | `CallAPI`<[`RepostStoryParams`](RepostStoryParams.md), [`TelegramStory`](TelegramStory.md)> | Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the *can\_manage\_stories* business bot right for both business accounts. Returns [Story](https://core.telegram.org/bots/api#story) on success. [Documentation](https://core.telegram.org/bots/api/#repoststory) | @gramio/types/out/methods.d.ts:880 |
|  `restrictChatMember` | `CallAPI`<[`RestrictChatMemberParams`](RestrictChatMemberParams.md), `true`> | Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass *True* for all permissions to lift restrictions from a user. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#restrictchatmember) | @gramio/types/out/methods.d.ts:281 |
|  `revokeChatInviteLink` | `CallAPI`<[`RevokeChatInviteLinkParams`](RevokeChatInviteLinkParams.md), [`TelegramChatInviteLink`](TelegramChatInviteLink.md)> | Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as [ChatInviteLink](https://core.telegram.org/bots/api#chatinvitelink) object. [Documentation](https://core.telegram.org/bots/api/#revokechatinvitelink) | @gramio/types/out/methods.d.ts:368 |
|  `savePreparedInlineMessage` | `CallAPI`<[`SavePreparedInlineMessageParams`](SavePreparedInlineMessageParams.md), [`TelegramPreparedInlineMessage`](TelegramPreparedInlineMessage.md)> | Stores a message that can be sent by a user of a Mini App. Returns a [PreparedInlineMessage](https://core.telegram.org/bots/api#preparedinlinemessage) object. [Documentation](https://core.telegram.org/bots/api/#savepreparedinlinemessage) | @gramio/types/out/methods.d.ts:1125 |
|  `sendAnimation` | `CallAPI`<[`SendAnimationParams`](SendAnimationParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. [Documentation](https://core.telegram.org/bots/api/#sendanimation) | @gramio/types/out/methods.d.ts:148 |
|  `sendAudio` | `CallAPI`<[`SendAudioParams`](SendAudioParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For sending voice messages, use the [sendVoice](https://core.telegram.org/bots/api#sendvoice) method instead. [Documentation](https://core.telegram.org/bots/api/#sendaudio) | @gramio/types/out/methods.d.ts:130 |
|  `sendChatAction` | `CallAPI`<[`SendChatActionParams`](SendChatActionParams.md), `true`> | Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns *True* on success. > Example: The [ImageBot](https://t.me/imagebot) needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use [sendChatAction](https://core.telegram.org/bots/api#sendchataction) with *action* = *upload\_photo*. The user will see a “sending photo” status for the bot. We only recommend using this method when a response from the bot will take a **noticeable** amount of time to arrive. [Documentation](https://core.telegram.org/bots/api/#sendchataction) | @gramio/types/out/methods.d.ts:227 |
|  `sendChecklist` | `CallAPI`<[`SendChecklistParams`](SendChecklistParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send a checklist on behalf of a connected business account. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#sendchecklist) | @gramio/types/out/methods.d.ts:205 |
|  `sendContact` | `CallAPI`<[`SendContactParams`](SendContactParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send phone contacts. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#sendcontact) | @gramio/types/out/methods.d.ts:193 |
|  `sendDice` | `CallAPI`<[`SendDiceParams`](SendDiceParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send an animated emoji that will display a random value. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#senddice) | @gramio/types/out/methods.d.ts:211 |
|  `sendDocument` | `CallAPI`<[`SendDocumentParams`](SendDocumentParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send general files. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. [Documentation](https://core.telegram.org/bots/api/#senddocument) | @gramio/types/out/methods.d.ts:136 |
|  `sendGame` | `CallAPI`<[`SendGameParams`](SendGameParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send a game. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#sendgame) | @gramio/types/out/methods.d.ts:1196 |
|  `sendGift` | `CallAPI`<[`SendGiftParams`](SendGiftParams.md), `true`> | Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#sendgift) | @gramio/types/out/methods.d.ts:721 |
|  `sendInvoice` | `CallAPI`<[`SendInvoiceParams`](SendInvoiceParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send invoices. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#sendinvoice) | @gramio/types/out/methods.d.ts:1134 |
|  `sendLocation` | `CallAPI`<[`SendLocationParams`](SendLocationParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send point on the map. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#sendlocation) | @gramio/types/out/methods.d.ts:181 |
|  `sendMediaGroup` | `CallAPI`<[`SendMediaGroupParams`](SendMediaGroupParams.md), [`TelegramMessage`](TelegramMessage.md)\[]> | Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of [Message](https://core.telegram.org/bots/api#message) objects that were sent is returned. [Documentation](https://core.telegram.org/bots/api/#sendmediagroup) | @gramio/types/out/methods.d.ts:172 |
|  `sendMessage` | `CallAPI`<[`SendMessageParams`](SendMessageParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send text messages. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#sendmessage) | @gramio/types/out/methods.d.ts:83 |
|  `sendMessageDraft` | `CallAPI`<[`SendMessageDraftParams`](SendMessageDraftParams.md), `true`> | Use this method to stream a partial message to a user while the message is being generated. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#sendmessagedraft) | @gramio/types/out/methods.d.ts:217 |
|  `sendPaidMedia` | `CallAPI`<[`SendPaidMediaParams`](SendPaidMediaParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send paid media. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#sendpaidmedia) | @gramio/types/out/methods.d.ts:166 |
|  `sendPhoto` | `CallAPI`<[`SendPhotoParams`](SendPhotoParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send photos. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#sendphoto) | @gramio/types/out/methods.d.ts:122 |
|  `sendPoll` | `CallAPI`<[`SendPollParams`](SendPollParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send a native poll. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#sendpoll) | @gramio/types/out/methods.d.ts:199 |
|  `sendSticker` | `CallAPI`<[`SendStickerParams`](SendStickerParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send static .WEBP, [animated](https://telegram.org/blog/animated-stickers) .TGS, or [video](https://telegram.org/blog/video-stickers-better-reactions) .WEBM stickers. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#sendsticker) | @gramio/types/out/methods.d.ts:1001 |
|  `sendVenue` | `CallAPI`<[`SendVenueParams`](SendVenueParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send information about a venue. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#sendvenue) | @gramio/types/out/methods.d.ts:187 |
|  `sendVideo` | `CallAPI`<[`SendVideoParams`](SendVideoParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as [Document](https://core.telegram.org/bots/api#document)). On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. [Documentation](https://core.telegram.org/bots/api/#sendvideo) | @gramio/types/out/methods.d.ts:142 |
|  `sendVideoNote` | `CallAPI`<[`SendVideoNoteParams`](SendVideoNoteParams.md), [`TelegramMessage`](TelegramMessage.md)> | As of [v.4.0](https://telegram.org/blog/video-messages-and-telescope), Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. [Documentation](https://core.telegram.org/bots/api/#sendvideonote) | @gramio/types/out/methods.d.ts:160 |
|  `sendVoice` | `CallAPI`<[`SendVoiceParams`](SendVoiceParams.md), [`TelegramMessage`](TelegramMessage.md)> | Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as [Audio](https://core.telegram.org/bots/api#audio) or [Document](https://core.telegram.org/bots/api#document)). On success, the sent [Message](https://core.telegram.org/bots/api#message) is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. [Documentation](https://core.telegram.org/bots/api/#sendvoice) | @gramio/types/out/methods.d.ts:154 |
|  `setBusinessAccountBio` | `CallAPI`<[`SetBusinessAccountBioParams`](SetBusinessAccountBioParams.md), `true`> | Changes the bio of a managed business account. Requires the *can\_change\_bio* business bot right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setbusinessaccountbio) | @gramio/types/out/methods.d.ts:784 |
|  `setBusinessAccountGiftSettings` | `CallAPI`<[`SetBusinessAccountGiftSettingsParams`](SetBusinessAccountGiftSettingsParams.md), `true`> | Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the *can\_change\_gift\_settings* business bot right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setbusinessaccountgiftsettings) | @gramio/types/out/methods.d.ts:808 |
|  `setBusinessAccountName` | `CallAPI`<[`SetBusinessAccountNameParams`](SetBusinessAccountNameParams.md), `true`> | Changes the first and last name of a managed business account. Requires the *can\_change\_name* business bot right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setbusinessaccountname) | @gramio/types/out/methods.d.ts:769 |
|  `setBusinessAccountProfilePhoto` | `CallAPI`<[`SetBusinessAccountProfilePhotoParams`](SetBusinessAccountProfilePhotoParams.md), `true`> | Changes the profile photo of a managed business account. Requires the *can\_edit\_profile\_photo* business bot right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setbusinessaccountprofilephoto) | @gramio/types/out/methods.d.ts:790 |
|  `setBusinessAccountUsername` | `CallAPI`<[`SetBusinessAccountUsernameParams`](SetBusinessAccountUsernameParams.md), `true`> | Changes the username of a managed business account. Requires the *can\_change\_username* business bot right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setbusinessaccountusername) | @gramio/types/out/methods.d.ts:775 |
|  `setChatAdministratorCustomTitle` | `CallAPI`<[`SetChatAdministratorCustomTitleParams`](SetChatAdministratorCustomTitleParams.md), `true`> | Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setchatadministratorcustomtitle) | @gramio/types/out/methods.d.ts:293 |
|  `setChatDescription` | `CallAPI`<[`SetChatDescriptionParams`](SetChatDescriptionParams.md), `true`> | Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setchatdescription) | @gramio/types/out/methods.d.ts:407 |
|  `setChatMemberTag` | `CallAPI`<[`SetChatMemberTagParams`](SetChatMemberTagParams.md), `true`> | Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_tags* administrator right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setchatmembertag) | @gramio/types/out/methods.d.ts:302 |
|  `setChatMenuButton` | `CallAPIWithOptionalParams`<[`SetChatMenuButtonParams`](SetChatMenuButtonParams.md), `true`> | Use this method to change the bot's menu button in a private chat, or the default menu button. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setchatmenubutton) | @gramio/types/out/methods.d.ts:679 |
|  `setChatPermissions` | `CallAPI`<[`SetChatPermissionsParams`](SetChatPermissionsParams.md), `true`> | Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the *can\_restrict\_members* administrator rights. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setchatpermissions) | @gramio/types/out/methods.d.ts:320 |
|  `setChatPhoto` | `CallAPI`<[`SetChatPhotoParams`](SetChatPhotoParams.md), `true`> | Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setchatphoto) | @gramio/types/out/methods.d.ts:389 |
|  `setChatStickerSet` | `CallAPI`<[`SetChatStickerSetParams`](SetChatStickerSetParams.md), `true`> | Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field *can\_set\_sticker\_set* optionally returned in [getChat](https://core.telegram.org/bots/api#getchat) requests to check if the bot can use this method. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setchatstickerset) | @gramio/types/out/methods.d.ts:467 |
|  `setChatTitle` | `CallAPI`<[`SetChatTitleParams`](SetChatTitleParams.md), `true`> | Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setchattitle) | @gramio/types/out/methods.d.ts:401 |
|  `setCustomEmojiStickerSetThumbnail` | `CallAPI`<[`SetCustomEmojiStickerSetThumbnailParams`](SetCustomEmojiStickerSetThumbnailParams.md), `true`> | Use this method to set the thumbnail of a custom emoji sticker set. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setcustomemojistickersetthumbnail) | @gramio/types/out/methods.d.ts:1094 |
|  `setGameScore` | `CallAPI`<[`SetGameScoreParams`](SetGameScoreParams.md), `true` | [`TelegramMessage`](TelegramMessage.md)> | Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the [Message](https://core.telegram.org/bots/api#message) is returned, otherwise *True* is returned. Returns an error, if the new score is not greater than the user's current score in the chat and *force* is *False*. [Documentation](https://core.telegram.org/bots/api/#setgamescore) | @gramio/types/out/methods.d.ts:1202 |
|  `setMessageReaction` | `CallAPI`<[`SetMessageReactionParams`](SetMessageReactionParams.md), `true`> | Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setmessagereaction) | @gramio/types/out/methods.d.ts:233 |
|  `setMyCommands` | `CallAPI`<[`SetMyCommandsParams`](SetMyCommandsParams.md), `true`> | Use this method to change the list of the bot's commands. See [this manual](https://core.telegram.org/bots/features#commands) for more details about bot commands. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setmycommands) | @gramio/types/out/methods.d.ts:592 |
|  `setMyDefaultAdministratorRights` | `CallAPIWithOptionalParams`<[`SetMyDefaultAdministratorRightsParams`](SetMyDefaultAdministratorRightsParams.md), `true`> | Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setmydefaultadministratorrights) | @gramio/types/out/methods.d.ts:697 |
|  `setMyDescription` | `CallAPIWithOptionalParams`<[`SetMyDescriptionParams`](SetMyDescriptionParams.md), `true`> | Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setmydescription) | @gramio/types/out/methods.d.ts:631 |
|  `setMyName` | `CallAPIWithOptionalParams`<[`SetMyNameParams`](SetMyNameParams.md), `true`> | Use this method to change the bot's name. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setmyname) | @gramio/types/out/methods.d.ts:616 |
|  `setMyProfilePhoto` | `CallAPI`<[`SetMyProfilePhotoParams`](SetMyProfilePhotoParams.md), `true`> | Changes the profile photo of the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setmyprofilephoto) | @gramio/types/out/methods.d.ts:667 |
|  `setMyShortDescription` | `CallAPIWithOptionalParams`<[`SetMyShortDescriptionParams`](SetMyShortDescriptionParams.md), `true`> | Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setmyshortdescription) | @gramio/types/out/methods.d.ts:649 |
|  `setPassportDataErrors` | `CallAPI`<[`SetPassportDataErrorsParams`](SetPassportDataErrorsParams.md), `true`> | Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns *True* on success. Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. [Documentation](https://core.telegram.org/bots/api/#setpassportdataerrors) | @gramio/types/out/methods.d.ts:1190 |
|  `setStickerEmojiList` | `CallAPI`<[`SetStickerEmojiListParams`](SetStickerEmojiListParams.md), `true`> | Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setstickeremojilist) | @gramio/types/out/methods.d.ts:1064 |
|  `setStickerKeywords` | `CallAPI`<[`SetStickerKeywordsParams`](SetStickerKeywordsParams.md), `true`> | Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setstickerkeywords) | @gramio/types/out/methods.d.ts:1070 |
|  `setStickerMaskPosition` | `CallAPI`<[`SetStickerMaskPositionParams`](SetStickerMaskPositionParams.md), `true`> | Use this method to change the [mask position](https://core.telegram.org/bots/api#maskposition) of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setstickermaskposition) | @gramio/types/out/methods.d.ts:1076 |
|  `setStickerPositionInSet` | `CallAPI`<[`SetStickerPositionInSetParams`](SetStickerPositionInSetParams.md), `true`> | Use this method to move a sticker in a set created by the bot to a specific position. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setstickerpositioninset) | @gramio/types/out/methods.d.ts:1046 |
|  `setStickerSetThumbnail` | `CallAPI`<[`SetStickerSetThumbnailParams`](SetStickerSetThumbnailParams.md), `true`> | Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setstickersetthumbnail) | @gramio/types/out/methods.d.ts:1088 |
|  `setStickerSetTitle` | `CallAPI`<[`SetStickerSetTitleParams`](SetStickerSetTitleParams.md), `true`> | Use this method to set the title of a created sticker set. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setstickersettitle) | @gramio/types/out/methods.d.ts:1082 |
|  `setUserEmojiStatus` | `CallAPI`<[`SetUserEmojiStatusParams`](SetUserEmojiStatusParams.md), `true`> | Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method [requestEmojiStatusAccess](https://core.telegram.org/bots/webapps#initializing-mini-apps). Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#setuseremojistatus) | @gramio/types/out/methods.d.ts:257 |
|  `setWebhook` | `CallAPI`<[`SetWebhookParams`](SetWebhookParams.md), `true`> | Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized [Update](https://core.telegram.org/bots/api#update). In case of an unsuccessful request (a request with response [HTTP status code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) different from `2XY`), we will repeat the request and give up after a reasonable amount of attempts. Returns *True* on success. If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter *secret\_token*. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content. [Documentation](https://core.telegram.org/bots/api/#setwebhook) | @gramio/types/out/methods.d.ts:47 |
|  `stopMessageLiveLocation` | `CallAPIWithOptionalParams`<[`StopMessageLiveLocationParams`](StopMessageLiveLocationParams.md), `true` | [`TelegramMessage`](TelegramMessage.md)> | Use this method to stop updating a live location message before *live\_period* expires. On success, if the message is not an inline message, the edited [Message](https://core.telegram.org/bots/api#message) is returned, otherwise *True* is returned. [Documentation](https://core.telegram.org/bots/api/#stopmessagelivelocation) | @gramio/types/out/methods.d.ts:934 |
|  `stopPoll` | `CallAPI`<[`StopPollParams`](StopPollParams.md), [`TelegramPoll`](TelegramPoll.md)> | Use this method to stop a poll which was sent by the bot. On success, the stopped [Poll](https://core.telegram.org/bots/api#poll) is returned. [Documentation](https://core.telegram.org/bots/api/#stoppoll) | @gramio/types/out/methods.d.ts:961 |
|  `transferBusinessAccountStars` | `CallAPI`<[`TransferBusinessAccountStarsParams`](TransferBusinessAccountStarsParams.md), `true`> | Transfers Telegram Stars from the business account balance to the bot's balance. Requires the *can\_transfer\_stars* business bot right. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#transferbusinessaccountstars) | @gramio/types/out/methods.d.ts:826 |
|  `transferGift` | `CallAPI`<[`TransferGiftParams`](TransferGiftParams.md), `true`> | Transfers an owned unique gift to another user. Requires the *can\_transfer\_and\_upgrade\_gifts* business bot right. Requires *can\_transfer\_stars* business bot right if the transfer is paid. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#transfergift) | @gramio/types/out/methods.d.ts:868 |
|  `unbanChatMember` | `CallAPI`<[`UnbanChatMemberParams`](UnbanChatMemberParams.md), `true`> | Use this method to unban a previously banned user in a supergroup or channel. The user will **not** return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be **removed** from the chat. If you don't want this, use the parameter *only\_if\_banned*. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#unbanchatmember) | @gramio/types/out/methods.d.ts:275 |
|  `unbanChatSenderChat` | `CallAPI`<[`UnbanChatSenderChatParams`](UnbanChatSenderChatParams.md), `true`> | Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#unbanchatsenderchat) | @gramio/types/out/methods.d.ts:314 |
|  `unhideGeneralForumTopic` | `CallAPI`<[`UnhideGeneralForumTopicParams`](UnhideGeneralForumTopicParams.md), `true`> | Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#unhidegeneralforumtopic) | @gramio/types/out/methods.d.ts:551 |
|  `unpinAllChatMessages` | `CallAPI`<[`UnpinAllChatMessagesParams`](UnpinAllChatMessagesParams.md), `true`> | Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can\_pin\_messages' right or the 'can\_edit\_messages' right to unpin all pinned messages in groups and channels respectively. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#unpinallchatmessages) | @gramio/types/out/methods.d.ts:425 |
|  `unpinAllForumTopicMessages` | `CallAPI`<[`UnpinAllForumTopicMessagesParams`](UnpinAllForumTopicMessagesParams.md), `true`> | Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can\_pin\_messages* administrator right in the supergroup. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#unpinallforumtopicmessages) | @gramio/types/out/methods.d.ts:518 |
|  `unpinAllGeneralForumTopicMessages` | `CallAPI`<[`UnpinAllGeneralForumTopicMessagesParams`](UnpinAllGeneralForumTopicMessagesParams.md), `true`> | Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the *can\_pin\_messages* administrator right in the supergroup. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#unpinallgeneralforumtopicmessages) | @gramio/types/out/methods.d.ts:557 |
|  `unpinChatMessage` | `CallAPI`<[`UnpinChatMessageParams`](UnpinChatMessageParams.md), `true`> | Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can\_pin\_messages' right or the 'can\_edit\_messages' right to unpin messages in groups and channels respectively. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#unpinchatmessage) | @gramio/types/out/methods.d.ts:419 |
|  `upgradeGift` | `CallAPI`<[`UpgradeGiftParams`](UpgradeGiftParams.md), `true`> | Upgrades a given regular gift to a unique gift. Requires the *can\_transfer\_and\_upgrade\_gifts* business bot right. Additionally requires the *can\_transfer\_stars* business bot right if the upgrade is paid. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#upgradegift) | @gramio/types/out/methods.d.ts:862 |
|  `uploadStickerFile` | `CallAPI`<[`UploadStickerFileParams`](UploadStickerFileParams.md), [`TelegramFile`](TelegramFile.md)> | Use this method to upload a file with a sticker for later use in the [createNewStickerSet](https://core.telegram.org/bots/api#createnewstickerset), [addStickerToSet](https://core.telegram.org/bots/api#addstickertoset), or [replaceStickerInSet](https://core.telegram.org/bots/api#replacestickerinset) methods (the file can be used multiple times). Returns the uploaded [File](https://core.telegram.org/bots/api#file) on success. [Documentation](https://core.telegram.org/bots/api/#uploadstickerfile) | @gramio/types/out/methods.d.ts:1025 |
|  `verifyChat` | `CallAPI`<[`VerifyChatParams`](VerifyChatParams.md), `true`> | Verifies a chat [on behalf of the organization](https://telegram.org/verify#third-party-verification) which is represented by the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#verifychat) | @gramio/types/out/methods.d.ts:739 |
|  `verifyUser` | `CallAPI`<[`VerifyUserParams`](VerifyUserParams.md), `true`> | Verifies a user [on behalf of the organization](https://telegram.org/verify#third-party-verification) which is represented by the bot. Returns *True* on success. [Documentation](https://core.telegram.org/bots/api/#verifyuser) | @gramio/types/out/methods.d.ts:733 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/ApproveChatJoinRequestParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / ApproveChatJoinRequestParams

# Interface: ApproveChatJoinRequestParams

Defined in: @gramio/types/out/params.d.ts:2071

Params object for [approveChatJoinRequest](APIMethods.md#approvechatjoinrequest) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2075 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:2079 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/ApproveSuggestedPostParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / ApproveSuggestedPostParams

# Interface: ApproveSuggestedPostParams

Defined in: @gramio/types/out/params.d.ts:3549

Params object for [approveSuggestedPost](APIMethods.md#approvesuggestedpost) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `number` | Unique identifier for the target direct messages chat | @gramio/types/out/params.d.ts:3553 |
|  `message_id` | `number` | Identifier of a suggested post message to approve | @gramio/types/out/params.d.ts:3557 |
|  `send_date?` | `number` | Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future | @gramio/types/out/params.d.ts:3561 |

---

---
url: 'https://gramio.dev/api/contexts/interfaces/AttachmentsMapping.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / AttachmentsMapping

# Interface: AttachmentsMapping

Defined in: contexts/index.d.ts:256

Mapping attachments type to their structures

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `animation` | [`AnimationAttachment`](../classes/AnimationAttachment.md) | contexts/index.d.ts:257 |
|  `audio` | [`AudioAttachment`](../classes/AudioAttachment.md) | contexts/index.d.ts:258 |
|  `contact` | [`ContactAttachment`](../classes/ContactAttachment.md) | contexts/index.d.ts:259 |
|  `document` | [`DocumentAttachment`](../classes/DocumentAttachment.md) | contexts/index.d.ts:260 |
|  `location` | [`LocationAttachment`](../classes/LocationAttachment.md) | contexts/index.d.ts:261 |
|  `photo` | [`PhotoAttachment`](../classes/PhotoAttachment.md) | contexts/index.d.ts:262 |
|  `poll` | [`PollAttachment`](../classes/PollAttachment.md) | contexts/index.d.ts:263 |
|  `sticker` | [`StickerAttachment`](../classes/StickerAttachment.md) | contexts/index.d.ts:264 |
|  `story` | [`StoryAttachment`](../classes/StoryAttachment.md) | contexts/index.d.ts:265 |
|  `venue` | [`VenueAttachment`](../classes/VenueAttachment.md) | contexts/index.d.ts:266 |
|  `video` | [`VideoAttachment`](../classes/VideoAttachment.md) | contexts/index.d.ts:268 |
|  `video_note` | [`VideoNoteAttachment`](../classes/VideoNoteAttachment.md) | contexts/index.d.ts:267 |
|  `voice` | [`VoiceAttachment`](../classes/VoiceAttachment.md) | contexts/index.d.ts:269 |

---

---
url: 'https://gramio.dev/api/autoload/interfaces/AutoloadOptions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/autoload/dist](../index.md) / AutoloadOptions

# Interface: AutoloadOptions

Defined in: autoload/index.d.ts:13

Options for [autoload](../index.md#autoload) plugin with options for Options | fdir and  PicomatchOptions | picomatch

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `failGlob?` | `boolean` | Throws an error if no matches are found. **Default** `true` | autoload/index.d.ts:36 |
|  `fdir?` | `Options` | Configure `fdir` options | autoload/index.d.ts:15 |
|  `import?` | `SoftString`<`"default"`> | (`file`) => `string` | import a specific `export` from a file **Example** `import: (file) => Object.keys(file).at(0) || "default",` **Default** `"default"` | autoload/index.d.ts:26 |
|  `onFinish?` | (`paths`) => `unknown` | The hook that is called after loading all files | autoload/index.d.ts:50 |
|  `onLoad?` | (`path`) => `unknown` | The hook that is called when loading a file | autoload/index.d.ts:48 |
|  `path?` | `string` | The path to the folder **Default** `"./commands"` | autoload/index.d.ts:46 |
|  `patterns?` | `string` | `string`\[] | [Glob patterns](%5C%3Chttps://en.wikipedia.org/wiki/Glob_\(programming\)>) **Default** `"**/*.{ts,js,cjs,mjs}"` | autoload/index.d.ts:31 |
|  `picomatch?` | `PicomatchOptions` | Configure `picomatch` options | autoload/index.d.ts:17 |
|  `skipImportErrors?` | `boolean` | Skip imports where needed `export` not defined **Default** `false` | autoload/index.d.ts:41 |

---

---
url: 'https://gramio.dev/api/autoload/interfaces/AutoloadOptionsPathParams.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/autoload/dist](../index.md) / AutoloadOptionsPathParams

# Interface: AutoloadOptionsPathParams

Defined in: autoload/index.d.ts:8

Params that used in [onLoad](AutoloadOptions.md#onload) and [onFinish](AutoloadOptions.md#onfinish) hooks

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `absolute` | `string` | autoload/index.d.ts:9 |
|  `relative` | `string` | autoload/index.d.ts:10 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/BanChatMemberParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / BanChatMemberParams

# Interface: BanChatMemberParams

Defined in: @gramio/types/out/params.d.ts:1721

Params object for [banChatMember](APIMethods.md#banchatmember) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target group or username of the target supergroup or channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1725 |
|  `revoke_messages?` | `boolean` | Pass *True* to delete all messages from the chat for the user that is being removed. If *False*, the user will be able to see messages in the group that were sent before the user was removed. Always *True* for supergroups and channels. | @gramio/types/out/params.d.ts:1737 |
|  `until_date?` | `number` | 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. Applied for supergroups and channels only. | @gramio/types/out/params.d.ts:1733 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:1729 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/BanChatSenderChatParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / BanChatSenderChatParams

# Interface: BanChatSenderChatParams

Defined in: @gramio/types/out/params.d.ts:1905

Params object for [banChatSenderChat](APIMethods.md#banchatsenderchat) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1909 |
|  `sender_chat_id` | `number` | Unique identifier of the target sender chat | @gramio/types/out/params.d.ts:1913 |

---

---
url: 'https://gramio.dev/api/contexts/interfaces/BotLike.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / BotLike

# Interface: BotLike

Defined in: contexts/index.d.ts:92

The required object that the contexts are based on

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `__Derives` | `Record`<[`UpdateName`](../type-aliases/UpdateName.md) | `"global"`, { }> | contexts/index.d.ts:93 |
|  `api` | `SuppressedAPIMethods` | contexts/index.d.ts:94 |

## Methods

### downloadFile()

#### Call Signature

> **downloadFile**(`attachment`): `Promise`<`ArrayBuffer`>

Defined in: contexts/index.d.ts:95

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `attachment` | `string` | [`Attachment`](../classes/Attachment.md) | { `file_id`: `string`; } |

##### Returns

`Promise`<`ArrayBuffer`>

#### Call Signature

> **downloadFile**(`attachment`, `path`): `Promise`<`string`>

Defined in: contexts/index.d.ts:98

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `attachment` | `string` | [`Attachment`](../classes/Attachment.md) | { `file_id`: `string`; } |
| `path` | `string` |

##### Returns

`Promise`<`string`>

---

---
url: 'https://gramio.dev/api/gramio/interfaces/BotOptions.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / BotOptions

# Interface: BotOptions

Defined in: gramio/index.d.ts:552

Bot options that you can provide to [Bot](../classes/Bot.md) constructor

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `api` | `object` | Options to configure how to send requests to the Telegram Bot API | gramio/index.d.ts:570 |
| `api.baseURL` | `string` | URL which will be used to send requests to. **Default** `"https://api.telegram.org/bot"` | gramio/index.d.ts:574 |
| `api.fetchOptions?` | `RequestInit` | Configure fetch parameters | gramio/index.d.ts:572 |
| `api.retryGetUpdatesWait?` | `number` | Time in milliseconds before calling [getUpdates](APIMethods.md#getupdates) again **Default** `1000` | gramio/index.d.ts:587 |
| `api.useTest?` | `boolean` | Should we send requests to `test` data center? 	The test environment is completely separate from the main environment, so you will need to create a new user account and a new bot with `@BotFather`. 	[Documentation](https://core.telegram.org/bots/webapps#using-bots-in-the-test-environment) **Default** `false` | gramio/index.d.ts:582 |
|  `info?` | [`TelegramUser`](TelegramUser.md) | When the bot begins to listen for updates, `GramIO` retrieves information about the bot to verify if the **bot token is valid** and to utilize some bot metadata. For example, this metadata will be used to strip bot mentions in commands. If you set it up, `GramIO` will not send a `getMe` request on startup. **Important** **You should set this up when horizontally scaling your bot or working in serverless environments.** | gramio/index.d.ts:563 |
|  `plugins?` | `object` | List of plugins enabled by default | gramio/index.d.ts:565 |
| `plugins.format?` | `boolean` | Pass `false` to disable plugin. **Default** `true` | gramio/index.d.ts:567 |
|  `token` | `string` | Bot token | gramio/index.d.ts:554 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/BotStartOptions.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / BotStartOptions

# Interface: BotStartOptions

Defined in: gramio/index.d.ts:822

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `allowedUpdates?` | (`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"business_connection"` | `"business_message"` | `"edited_business_message"` | `"deleted_business_messages"` | `"message_reaction"` | `"message_reaction_count"` | `"inline_query"` | `"chosen_inline_result"` | `"callback_query"` | `"shipping_query"` | `"pre_checkout_query"` | `"purchased_paid_media"` | `"poll"` | `"poll_answer"` | `"my_chat_member"` | `"chat_member"` | `"chat_join_request"` | `"chat_boost"` | `"removed_chat_boost"`)\[] | gramio/index.d.ts:826 |
|  `deleteWebhook?` | `boolean` | `"on-conflict-with-polling"` | gramio/index.d.ts:827 |
|  `dropPendingUpdates?` | `boolean` | gramio/index.d.ts:825 |
|  `longPolling?` | [`BotStartOptionsLongPolling`](../type-aliases/BotStartOptionsLongPolling.md) | gramio/index.d.ts:824 |
|  `webhook?` | [`BotStartOptionsWebhook`](../type-aliases/BotStartOptionsWebhook.md) | gramio/index.d.ts:823 |

---

---
url: 'https://gramio.dev/api/keyboards/interfaces/ButtonOptions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / ButtonOptions

# Interface: ButtonOptions

Defined in: keyboards/index.d.ts:3

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `icon_custom_emoji_id?` | `string` | keyboards/index.d.ts:5 |
|  `style?` | `"danger"` | `"success"` | `"primary"` | keyboards/index.d.ts:4 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/CloseForumTopicParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / CloseForumTopicParams

# Interface: CloseForumTopicParams

Defined in: @gramio/types/out/params.d.ts:2331

Params object for [closeForumTopic](APIMethods.md#closeforumtopic) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2335 |
|  `message_thread_id` | `number` | Unique identifier for the target message thread of the forum topic | @gramio/types/out/params.d.ts:2339 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/CloseGeneralForumTopicParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / CloseGeneralForumTopicParams

# Interface: CloseGeneralForumTopicParams

Defined in: @gramio/types/out/params.d.ts:2401

Params object for [closeGeneralForumTopic](APIMethods.md#closegeneralforumtopic) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2405 |

---

---
url: 'https://gramio.dev/api/composer/interfaces/ComposerOptions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / ComposerOptions

# Interface: ComposerOptions

Defined in: composer/index.d.ts:123

Composer constructor options

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `name?` | `string` | composer/index.d.ts:124 |
|  `seed?` | `unknown` | composer/index.d.ts:125 |

---

---
url: 'https://gramio.dev/api/composer/interfaces/ContextCallback.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / ContextCallback

# Interface: ContextCallback()

Defined in: composer/index.d.ts:37

Marker type for context-aware callbacks in macro options.
The framework replaces this with the actual handler context type at the call site.

## Example

```ts
interface ThrottleOptions {
  limit: number;
  onLimit?: ContextCallback;  // ← framework substitutes the real ctx type
}
```

> **ContextCallback**(`ctx`): `unknown`

Defined in: composer/index.d.ts:39

Marker type for context-aware callbacks in macro options.
The framework replaces this with the actual handler context type at the call site.

## Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | `never` |

## Returns

`unknown`

## Example

```ts
interface ThrottleOptions {
  limit: number;
  onLimit?: ContextCallback;  // ← framework substitutes the real ctx type
}
```

## Properties

| Property | Modifier | Type | Defined in |
| ------ | ------ | ------ | ------ |
|  `[ContextCallbackBrand]` | `readonly` | `true` | composer/index.d.ts:38 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/ConvertGiftToStarsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / ConvertGiftToStarsParams

# Interface: ConvertGiftToStarsParams

Defined in: @gramio/types/out/params.d.ts:3087

Params object for [convertGiftToStars](APIMethods.md#convertgifttostars) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:3091 |
|  `owned_gift_id` | `string` | Unique identifier of the regular gift that should be converted to Telegram Stars | @gramio/types/out/params.d.ts:3095 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/CopyMessageParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / CopyMessageParams

# Interface: CopyMessageParams

Defined in: @gramio/types/out/params.d.ts:245

Params object for [copyMessage](APIMethods.md#copymessage) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:297 |
|  `caption?` | `string` | { `toString`: `string`; } | New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept | @gramio/types/out/params.d.ts:273 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:281 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:249 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:257 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:289 |
|  `from_chat_id` | `string` | `number` | Unique identifier for the chat where the original message was sent (or channel username in the format `@channelusername`) | @gramio/types/out/params.d.ts:261 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; only available when copying to private chats | @gramio/types/out/params.d.ts:301 |
|  `message_id` | `number` | Message identifier in the chat specified in *from\_chat\_id* | @gramio/types/out/params.d.ts:265 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:253 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the new caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:277 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:293 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:313 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:309 |
|  `show_caption_above_media?` | `boolean` | Pass *True*, if the caption must be shown above the message media. Ignored if a new caption isn't specified. | @gramio/types/out/params.d.ts:285 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:305 |
|  `video_start_timestamp?` | `number` | New start timestamp for the copied video in the message | @gramio/types/out/params.d.ts:269 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/CopyMessagesParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / CopyMessagesParams

# Interface: CopyMessagesParams

Defined in: @gramio/types/out/params.d.ts:327

Params object for [copyMessages](APIMethods.md#copymessages) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:331 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat | @gramio/types/out/params.d.ts:339 |
|  `disable_notification?` | `boolean` | Sends the messages [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:351 |
|  `from_chat_id` | `string` | `number` | Unique identifier for the chat where the original messages were sent (or channel username in the format `@channelusername`) | @gramio/types/out/params.d.ts:343 |
|  `message_ids` | `number`\[] | A JSON-serialized list of 1-100 identifiers of messages in the chat *from\_chat\_id* to copy. The identifiers must be specified in a strictly increasing order. | @gramio/types/out/params.d.ts:347 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:335 |
|  `protect_content?` | `boolean` | Protects the contents of the sent messages from forwarding and saving | @gramio/types/out/params.d.ts:355 |
|  `remove_caption?` | `boolean` | Pass *True* to copy the messages without their captions | @gramio/types/out/params.d.ts:359 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/CreateChatInviteLinkParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / CreateChatInviteLinkParams

# Interface: CreateChatInviteLinkParams

Defined in: @gramio/types/out/params.d.ts:1961

Params object for [createChatInviteLink](APIMethods.md#createchatinvitelink) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1965 |
|  `creates_join_request?` | `boolean` | *True*, if users joining the chat via the link need to be approved by chat administrators. If *True*, *member\_limit* can't be specified | @gramio/types/out/params.d.ts:1981 |
|  `expire_date?` | `number` | Point in time (Unix timestamp) when the link will expire | @gramio/types/out/params.d.ts:1973 |
|  `member_limit?` | `number` | The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 | @gramio/types/out/params.d.ts:1977 |
|  `name?` | `string` | Invite link name; 0-32 characters | @gramio/types/out/params.d.ts:1969 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/CreateChatSubscriptionInviteLinkParams.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / CreateChatSubscriptionInviteLinkParams

# Interface: CreateChatSubscriptionInviteLinkParams

Defined in: @gramio/types/out/params.d.ts:2017

Params object for [createChatSubscriptionInviteLink](APIMethods.md#createchatsubscriptioninvitelink) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target channel chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2021 |
|  `name?` | `string` | Invite link name; 0-32 characters | @gramio/types/out/params.d.ts:2025 |
|  `subscription_period` | `number` | The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days). | @gramio/types/out/params.d.ts:2029 |
|  `subscription_price` | `number` | The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000 | @gramio/types/out/params.d.ts:2033 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/CreateForumTopicParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / CreateForumTopicParams

# Interface: CreateForumTopicParams

Defined in: @gramio/types/out/params.d.ts:2287

Params object for [createForumTopic](APIMethods.md#createforumtopic) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2291 |
|  `icon_color?` | [`CreateForumTopicIconColor`](../type-aliases/CreateForumTopicIconColor.md) | Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F) | @gramio/types/out/params.d.ts:2299 |
|  `icon_custom_emoji_id?` | `string` | Unique identifier of the custom emoji shown as the topic icon. Use [getForumTopicIconStickers](https://core.telegram.org/bots/api#getforumtopiciconstickers) to get all allowed custom emoji identifiers. | @gramio/types/out/params.d.ts:2303 |
|  `name` | `string` | Topic name, 1-128 characters | @gramio/types/out/params.d.ts:2295 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/CreateInvoiceLinkParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / CreateInvoiceLinkParams

# Interface: CreateInvoiceLinkParams

Defined in: @gramio/types/out/params.d.ts:4125

Params object for [createInvoiceLink](APIMethods.md#createinvoicelink) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the link will be created. For payments in [Telegram Stars](https://t.me/BotNews/90) only. | @gramio/types/out/params.d.ts:4129 |
|  `currency` | [`TelegramCurrencies`](../type-aliases/TelegramCurrencies.md) | Three-letter ISO 4217 currency code, see [more on currencies](https://core.telegram.org/bots/payments#supported-currencies). Pass “XTR” for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4149 |
|  `description` | `string` | Product description, 1-255 characters | @gramio/types/out/params.d.ts:4137 |
|  `is_flexible?` | `boolean` | Pass *True* if the final price depends on the shipping method. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4213 |
|  `max_tip_amount?` | `number` | The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of `US$ 1.45` pass `max_tip_amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4161 |
|  `need_email?` | `boolean` | Pass *True* if you require the user's email address to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4197 |
|  `need_name?` | `boolean` | Pass *True* if you require the user's full name to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4189 |
|  `need_phone_number?` | `boolean` | Pass *True* if you require the user's phone number to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4193 |
|  `need_shipping_address?` | `boolean` | Pass *True* if you require the user's shipping address to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4201 |
|  `payload` | `string` | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. | @gramio/types/out/params.d.ts:4141 |
|  `photo_height?` | `number` | Photo height | @gramio/types/out/params.d.ts:4185 |
|  `photo_size?` | `number` | Photo size in bytes | @gramio/types/out/params.d.ts:4177 |
|  `photo_url?` | `string` | URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. | @gramio/types/out/params.d.ts:4173 |
|  `photo_width?` | `number` | Photo width | @gramio/types/out/params.d.ts:4181 |
|  `prices` | [`TelegramLabeledPrice`](TelegramLabeledPrice.md)\[] | Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4153 |
|  `provider_data?` | `string` | JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. | @gramio/types/out/params.d.ts:4169 |
|  `provider_token?` | `string` | Payment provider token, obtained via [@BotFather](https://t.me/botfather). Pass an empty string for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4145 |
|  `send_email_to_provider?` | `boolean` | Pass *True* if the user's email address should be sent to the provider. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4209 |
|  `send_phone_number_to_provider?` | `boolean` | Pass *True* if the user's phone number should be sent to the provider. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4205 |
|  `subscription_period?` | `number` | The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars. | @gramio/types/out/params.d.ts:4157 |
|  `suggested_tip_amounts?` | `number`\[] | A JSON-serialized array of suggested amounts of tips in the *smallest units* of the currency (integer, **not** float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed *max\_tip\_amount*. | @gramio/types/out/params.d.ts:4165 |
|  `title` | `string` | Product name, 1-32 characters | @gramio/types/out/params.d.ts:4133 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/CreateNewStickerSetParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / CreateNewStickerSetParams

# Interface: CreateNewStickerSetParams

Defined in: @gramio/types/out/params.d.ts:3721

Params object for [createNewStickerSet](APIMethods.md#createnewstickerset) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `name` | `string` | Short name of sticker set, to be used in `t.me/addstickers/` URLs (e.g., *animals*). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in `"_by_<bot_username>"`. `<bot_username>` is case insensitive. 1-64 characters. | @gramio/types/out/params.d.ts:3729 |
|  `needs_repainting?` | `boolean` | Pass *True* if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only | @gramio/types/out/params.d.ts:3745 |
|  `sticker_type?` | [`CreateNewStickerSetStickerType`](../type-aliases/CreateNewStickerSetStickerType.md) | Type of stickers in the set, pass “regular”, “mask”, or “custom\_emoji”. By default, a regular sticker set is created. | @gramio/types/out/params.d.ts:3741 |
|  `stickers` | [`TelegramInputSticker`](TelegramInputSticker.md)\[] | A JSON-serialized list of 1-50 initial stickers to be added to the sticker set | @gramio/types/out/params.d.ts:3737 |
|  `title` | `string` | Sticker set title, 1-64 characters | @gramio/types/out/params.d.ts:3733 |
|  `user_id` | `number` | User identifier of created sticker set owner | @gramio/types/out/params.d.ts:3725 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeclineChatJoinRequestParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeclineChatJoinRequestParams

# Interface: DeclineChatJoinRequestParams

Defined in: @gramio/types/out/params.d.ts:2085

Params object for [declineChatJoinRequest](APIMethods.md#declinechatjoinrequest) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2089 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:2093 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeclineSuggestedPostParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeclineSuggestedPostParams

# Interface: DeclineSuggestedPostParams

Defined in: @gramio/types/out/params.d.ts:3567

Params object for [declineSuggestedPost](APIMethods.md#declinesuggestedpost) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `number` | Unique identifier for the target direct messages chat | @gramio/types/out/params.d.ts:3571 |
|  `comment?` | `string` | Comment for the creator of the suggested post; 0-128 characters | @gramio/types/out/params.d.ts:3579 |
|  `message_id` | `number` | Identifier of a suggested post message to decline | @gramio/types/out/params.d.ts:3575 |

---

---
url: 'https://gramio.dev/api/contexts/interfaces/DefaultAttachment.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / DefaultAttachment

# Interface: DefaultAttachment

Defined in: contexts/index.d.ts:318

Base interface for attachment

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `file_id` | `string` | contexts/index.d.ts:319 |
|  `file_unique_id` | `string` | contexts/index.d.ts:320 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeleteBusinessMessagesParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeleteBusinessMessagesParams

# Interface: DeleteBusinessMessagesParams

Defined in: @gramio/types/out/params.d.ts:2811

Params object for [deleteBusinessMessages](APIMethods.md#deletebusinessmessages) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection on behalf of which to delete the messages | @gramio/types/out/params.d.ts:2815 |
|  `message_ids` | `number`\[] | A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See [deleteMessage](https://core.telegram.org/bots/api#deletemessage) for limitations on which messages can be deleted | @gramio/types/out/params.d.ts:2819 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeleteChatPhotoParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeleteChatPhotoParams

# Interface: DeleteChatPhotoParams

Defined in: @gramio/types/out/params.d.ts:2113

Params object for [deleteChatPhoto](APIMethods.md#deletechatphoto) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2117 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeleteChatStickerSetParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeleteChatStickerSetParams

# Interface: DeleteChatStickerSetParams

Defined in: @gramio/types/out/params.d.ts:2269

Params object for [deleteChatStickerSet](APIMethods.md#deletechatstickerset) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2273 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeleteForumTopicParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeleteForumTopicParams

# Interface: DeleteForumTopicParams

Defined in: @gramio/types/out/params.d.ts:2359

Params object for [deleteForumTopic](APIMethods.md#deleteforumtopic) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2363 |
|  `message_thread_id` | `number` | Unique identifier for the target message thread of the forum topic | @gramio/types/out/params.d.ts:2367 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeleteMessageParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeleteMessageParams

# Interface: DeleteMessageParams

Defined in: @gramio/types/out/params.d.ts:3585

Params object for [deleteMessage](APIMethods.md#deletemessage) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:3589 |
|  `message_id` | `number` | Identifier of the message to delete | @gramio/types/out/params.d.ts:3593 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeleteMessagesParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeleteMessagesParams

# Interface: DeleteMessagesParams

Defined in: @gramio/types/out/params.d.ts:3599

Params object for [deleteMessages](APIMethods.md#deletemessages) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:3603 |
|  `message_ids` | `number`\[] | A JSON-serialized list of 1-100 identifiers of messages to delete. See [deleteMessage](https://core.telegram.org/bots/api#deletemessage) for limitations on which messages can be deleted | @gramio/types/out/params.d.ts:3607 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeleteMyCommandsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeleteMyCommandsParams

# Interface: DeleteMyCommandsParams

Defined in: @gramio/types/out/params.d.ts:2521

Params object for [deleteMyCommands](APIMethods.md#deletemycommands) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `language_code?` | `string` | A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands | @gramio/types/out/params.d.ts:2529 |
|  `scope?` | [`TelegramBotCommandScope`](../type-aliases/TelegramBotCommandScope.md) | A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to [BotCommandScopeDefault](https://core.telegram.org/bots/api#botcommandscopedefault). | @gramio/types/out/params.d.ts:2525 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeleteStickerFromSetParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeleteStickerFromSetParams

# Interface: DeleteStickerFromSetParams

Defined in: @gramio/types/out/params.d.ts:3783

Params object for [deleteStickerFromSet](APIMethods.md#deletestickerfromset) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `sticker` | `string` | File identifier of the sticker | @gramio/types/out/params.d.ts:3787 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeleteStickerSetParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeleteStickerSetParams

# Interface: DeleteStickerSetParams

Defined in: @gramio/types/out/params.d.ts:3909

Params object for [deleteStickerSet](APIMethods.md#deletestickerset) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `name` | `string` | Sticker set name | @gramio/types/out/params.d.ts:3913 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeleteStoryParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeleteStoryParams

# Interface: DeleteStoryParams

Defined in: @gramio/types/out/params.d.ts:3255

Params object for [deleteStory](APIMethods.md#deletestory) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:3259 |
|  `story_id` | `number` | Unique identifier of the story to delete | @gramio/types/out/params.d.ts:3263 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/DeleteWebhookParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeleteWebhookParams

# Interface: DeleteWebhookParams

Defined in: @gramio/types/out/params.d.ts:81

Params object for [deleteWebhook](APIMethods.md#deletewebhook) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `drop_pending_updates?` | `boolean` | Pass *True* to drop all pending updates | @gramio/types/out/params.d.ts:85 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/EditChatInviteLinkParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / EditChatInviteLinkParams

# Interface: EditChatInviteLinkParams

Defined in: @gramio/types/out/params.d.ts:1987

Params object for [editChatInviteLink](APIMethods.md#editchatinvitelink) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1991 |
|  `creates_join_request?` | `boolean` | *True*, if users joining the chat via the link need to be approved by chat administrators. If *True*, *member\_limit* can't be specified | @gramio/types/out/params.d.ts:2011 |
|  `expire_date?` | `number` | Point in time (Unix timestamp) when the link will expire | @gramio/types/out/params.d.ts:2003 |
|  `invite_link` | `string` | The invite link to edit | @gramio/types/out/params.d.ts:1995 |
|  `member_limit?` | `number` | The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 | @gramio/types/out/params.d.ts:2007 |
|  `name?` | `string` | Invite link name; 0-32 characters | @gramio/types/out/params.d.ts:1999 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/EditChatSubscriptionInviteLinkParams.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / EditChatSubscriptionInviteLinkParams

# Interface: EditChatSubscriptionInviteLinkParams

Defined in: @gramio/types/out/params.d.ts:2039

Params object for [editChatSubscriptionInviteLink](APIMethods.md#editchatsubscriptioninvitelink) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2043 |
|  `invite_link` | `string` | The invite link to edit | @gramio/types/out/params.d.ts:2047 |
|  `name?` | `string` | Invite link name; 0-32 characters | @gramio/types/out/params.d.ts:2051 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/EditForumTopicParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / EditForumTopicParams

# Interface: EditForumTopicParams

Defined in: @gramio/types/out/params.d.ts:2309

Params object for [editForumTopic](APIMethods.md#editforumtopic) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2313 |
|  `icon_custom_emoji_id?` | `string` | New unique identifier of the custom emoji shown as the topic icon. Use [getForumTopicIconStickers](https://core.telegram.org/bots/api#getforumtopiciconstickers) to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept | @gramio/types/out/params.d.ts:2325 |
|  `message_thread_id` | `number` | Unique identifier for the target message thread of the forum topic | @gramio/types/out/params.d.ts:2317 |
|  `name?` | `string` | New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept | @gramio/types/out/params.d.ts:2321 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/EditGeneralForumTopicParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / EditGeneralForumTopicParams

# Interface: EditGeneralForumTopicParams

Defined in: @gramio/types/out/params.d.ts:2387

Params object for [editGeneralForumTopic](APIMethods.md#editgeneralforumtopic) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2391 |
|  `name` | `string` | New topic name, 1-128 characters | @gramio/types/out/params.d.ts:2395 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/EditMessageCaptionParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / EditMessageCaptionParams

# Interface: EditMessageCaptionParams

Defined in: @gramio/types/out/params.d.ts:3313

Params object for [editMessageCaption](APIMethods.md#editmessagecaption) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message to be edited was sent | @gramio/types/out/params.d.ts:3317 |
|  `caption?` | `string` | { `toString`: `string`; } | New caption of the message, 0-1024 characters after entities parsing | @gramio/types/out/params.d.ts:3333 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:3341 |
|  `chat_id?` | `string` | `number` | Required if *inline\_message\_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:3321 |
|  `inline_message_id?` | `string` | Required if *chat\_id* and *message\_id* are not specified. Identifier of the inline message | @gramio/types/out/params.d.ts:3329 |
|  `message_id?` | `number` | Required if *inline\_message\_id* is not specified. Identifier of the message to edit | @gramio/types/out/params.d.ts:3325 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the message caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:3337 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards). | @gramio/types/out/params.d.ts:3349 |
|  `show_caption_above_media?` | `boolean` | Pass *True*, if the caption must be shown above the message media. Supported only for animation, photo and video messages. | @gramio/types/out/params.d.ts:3345 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/EditMessageChecklistParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / EditMessageChecklistParams

# Interface: EditMessageChecklistParams

Defined in: @gramio/types/out/params.d.ts:3469

Params object for [editMessageChecklist](APIMethods.md#editmessagechecklist) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:3473 |
|  `chat_id` | `number` | Unique identifier for the target chat | @gramio/types/out/params.d.ts:3477 |
|  `checklist` | [`TelegramInputChecklist`](TelegramInputChecklist.md) | A JSON-serialized object for the new checklist | @gramio/types/out/params.d.ts:3485 |
|  `message_id` | `number` | Unique identifier for the target message | @gramio/types/out/params.d.ts:3481 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | A JSON-serialized object for the new [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) for the message | @gramio/types/out/params.d.ts:3489 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/EditMessageLiveLocationParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / EditMessageLiveLocationParams

# Interface: EditMessageLiveLocationParams

Defined in: @gramio/types/out/params.d.ts:3389

Params object for [editMessageLiveLocation](APIMethods.md#editmessagelivelocation) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message to be edited was sent | @gramio/types/out/params.d.ts:3393 |
|  `chat_id?` | `string` | `number` | Required if *inline\_message\_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:3397 |
|  `heading?` | `number` | Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | @gramio/types/out/params.d.ts:3425 |
|  `horizontal_accuracy?` | `number` | The radius of uncertainty for the location, measured in meters; 0-1500 | @gramio/types/out/params.d.ts:3421 |
|  `inline_message_id?` | `string` | Required if *chat\_id* and *message\_id* are not specified. Identifier of the inline message | @gramio/types/out/params.d.ts:3405 |
|  `latitude` | `number` | Latitude of new location | @gramio/types/out/params.d.ts:3409 |
|  `live_period?` | `number` | New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current *live\_period* by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then *live\_period* remains unchanged | @gramio/types/out/params.d.ts:3417 |
|  `longitude` | `number` | Longitude of new location | @gramio/types/out/params.d.ts:3413 |
|  `message_id?` | `number` | Required if *inline\_message\_id* is not specified. Identifier of the message to edit | @gramio/types/out/params.d.ts:3401 |
|  `proximity_alert_radius?` | `number` | The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | @gramio/types/out/params.d.ts:3429 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | A JSON-serialized object for a new [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards). | @gramio/types/out/params.d.ts:3433 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/EditMessageMediaParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / EditMessageMediaParams

# Interface: EditMessageMediaParams

Defined in: @gramio/types/out/params.d.ts:3357

Params object for [editMessageMedia](APIMethods.md#editmessagemedia) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message to be edited was sent | @gramio/types/out/params.d.ts:3361 |
|  `chat_id?` | `string` | `number` | Required if *inline\_message\_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:3365 |
|  `inline_message_id?` | `string` | Required if *chat\_id* and *message\_id* are not specified. Identifier of the inline message | @gramio/types/out/params.d.ts:3373 |
|  `media` | [`TelegramInputMedia`](../type-aliases/TelegramInputMedia.md) | A JSON-serialized object for a new media content of the message | @gramio/types/out/params.d.ts:3377 |
|  `message_id?` | `number` | Required if *inline\_message\_id* is not specified. Identifier of the message to edit | @gramio/types/out/params.d.ts:3369 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | A JSON-serialized object for a new [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards). | @gramio/types/out/params.d.ts:3381 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/EditMessageReplyMarkupParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / EditMessageReplyMarkupParams

# Interface: EditMessageReplyMarkupParams

Defined in: @gramio/types/out/params.d.ts:3497

Params object for [editMessageReplyMarkup](APIMethods.md#editmessagereplymarkup) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message to be edited was sent | @gramio/types/out/params.d.ts:3501 |
|  `chat_id?` | `string` | `number` | Required if *inline\_message\_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:3505 |
|  `inline_message_id?` | `string` | Required if *chat\_id* and *message\_id* are not specified. Identifier of the inline message | @gramio/types/out/params.d.ts:3513 |
|  `message_id?` | `number` | Required if *inline\_message\_id* is not specified. Identifier of the message to edit | @gramio/types/out/params.d.ts:3509 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards). | @gramio/types/out/params.d.ts:3517 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/EditMessageTextParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / EditMessageTextParams

# Interface: EditMessageTextParams

Defined in: @gramio/types/out/params.d.ts:3269

Params object for [editMessageText](APIMethods.md#editmessagetext) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message to be edited was sent | @gramio/types/out/params.d.ts:3273 |
|  `chat_id?` | `string` | `number` | Required if *inline\_message\_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:3277 |
|  `entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in message text, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:3297 |
|  `inline_message_id?` | `string` | Required if *chat\_id* and *message\_id* are not specified. Identifier of the inline message | @gramio/types/out/params.d.ts:3285 |
|  `link_preview_options?` | [`TelegramLinkPreviewOptions`](TelegramLinkPreviewOptions.md) | Link preview generation options for the message | @gramio/types/out/params.d.ts:3301 |
|  `message_id?` | `number` | Required if *inline\_message\_id* is not specified. Identifier of the message to edit | @gramio/types/out/params.d.ts:3281 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the message text. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:3293 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards). | @gramio/types/out/params.d.ts:3305 |
|  `text` | `string` | { `toString`: `string`; } | New text of the message, 1-4096 characters after entities parsing | @gramio/types/out/params.d.ts:3289 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/EditStoryParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / EditStoryParams

# Interface: EditStoryParams

Defined in: @gramio/types/out/params.d.ts:3221

Params object for [editStory](APIMethods.md#editstory) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `areas?` | [`TelegramStoryArea`](TelegramStoryArea.md)\[] | A JSON-serialized list of clickable areas to be shown on the story | @gramio/types/out/params.d.ts:3249 |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:3225 |
|  `caption?` | `string` | { `toString`: `string`; } | Caption of the story, 0-2048 characters after entities parsing | @gramio/types/out/params.d.ts:3237 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:3245 |
|  `content` | [`TelegramInputStoryContent`](../type-aliases/TelegramInputStoryContent.md) | Content of the story | @gramio/types/out/params.d.ts:3233 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the story caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:3241 |
|  `story_id` | `number` | Unique identifier of the story to edit | @gramio/types/out/params.d.ts:3229 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/EditUserStarSubscriptionParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / EditUserStarSubscriptionParams

# Interface: EditUserStarSubscriptionParams

Defined in: @gramio/types/out/params.d.ts:4287

Params object for [editUserStarSubscription](APIMethods.md#edituserstarsubscription) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `is_canceled` | `boolean` | Pass *True* to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass *False* to allow the user to re-enable a subscription that was previously canceled by the bot. | @gramio/types/out/params.d.ts:4299 |
|  `telegram_payment_charge_id` | `string` | Telegram payment identifier for the subscription | @gramio/types/out/params.d.ts:4295 |
|  `user_id` | `number` | Identifier of the user whose subscription will be edited | @gramio/types/out/params.d.ts:4291 |

---

---
url: 'https://gramio.dev/api/scenes/interfaces/EnterExit.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / EnterExit

# Interface: EnterExit

Defined in: scenes/index.d.ts:173

## Extended by

* [`InActiveSceneHandlerReturn`](InActiveSceneHandlerReturn.md)
* [`PossibleInUnknownScene`](PossibleInUnknownScene.md)

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `enter` | [`SceneEnterHandler`](../type-aliases/SceneEnterHandler.md) | scenes/index.d.ts:174 |
|  `exit` | () => [`MaybePromise`](../../../../gramio/type-aliases/MaybePromise.md)<`boolean`> | scenes/index.d.ts:175 |

---

---
url: 'https://gramio.dev/api/composer/interfaces/EventComposer.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / EventComposer

# Interface: EventComposer\<TBase, TEventMap, TIn, TOut, TExposed, TDerives, TMethods, TMacros>

Defined in: composer/index.d.ts:261

EventComposer interface — Composer + .on() + per-event derive tracking + custom methods

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `TBase` *extends* `object` | - |
| `TEventMap` *extends* `Record`<`string`, `TBase`> | - |
| `TIn` *extends* `TBase` | `TBase` |
| `TOut` *extends* `TIn` | `TIn` |
| `TExposed` *extends* `object` | `object` |
| `TDerives` *extends* `Record`<`string`, `object`> | `object` |
| `TMethods` *extends* `Record`<`string`, (...`args`) => `any`> | `object` |
| `TMacros` *extends* [`MacroDefinitions`](../type-aliases/MacroDefinitions.md) | `object` |

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `~` | `object` | - | composer/index.d.ts:307 |
| `~.compiled` | [`ComposedMiddleware`](../type-aliases/ComposedMiddleware.md)<`any`> | - | composer/index.d.ts:311 |
| `~.Derives` | `TDerives` | - | composer/index.d.ts:320 |
| `~.errorsDefinitions` | `Record`<`string`, {(...`args`): `any`; `prototype`: `Error`; }> | - | composer/index.d.ts:314 |
| `~.extended` | `Set`<`string`> | - | composer/index.d.ts:310 |
| `~.macros` | `Record`<`string`, [`MacroDef`](../type-aliases/MacroDef.md)<`any`, `any`>> | - | composer/index.d.ts:319 |
| `~.middlewares` | `ScopedMiddleware`<`any`>\[] | - | composer/index.d.ts:308 |
| `~.name` | `string` | - | composer/index.d.ts:312 |
| `~.onErrors` | [`ErrorHandler`](../type-aliases/ErrorHandler.md)<`any`>\[] | - | composer/index.d.ts:309 |
| `~.Out` | `TOut` | Phantom type accessor — never set at runtime, used by `ContextOf<T>` | composer/index.d.ts:322 |
| `~.seed` | `unknown` | - | composer/index.d.ts:313 |
| `~.tracer` | [`TraceHandler`](../type-aliases/TraceHandler.md) | - | composer/index.d.ts:318 |

## Methods

### as()

> **as**(`scope`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut`, `TOut`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

Defined in: composer/index.d.ts:296

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `scope` | `"global"` | `"scoped"` |

#### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut`, `TOut`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

***

### branch()

> **branch**(`predicate`, `onTrue`, `onFalse?`): `this`

Defined in: composer/index.d.ts:271

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `predicate` | `boolean` | (`context`) => `boolean` | `Promise`<`boolean`> |
| `onTrue` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`> |
| `onFalse?` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`> |

#### Returns

`this`

***

### compose()

> **compose**(): [`ComposedMiddleware`](../type-aliases/ComposedMiddleware.md)<`TIn`>

Defined in: composer/index.d.ts:305

#### Returns

[`ComposedMiddleware`](../type-aliases/ComposedMiddleware.md)<`TIn`>

***

### decorate()

#### Call Signature

> **decorate**<`D`>(`values`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `D`, `TExposed`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

Defined in: composer/index.d.ts:284

##### Type Parameters

| Type Parameter |
| ------ |
| `D` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `values` | `D` |

##### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `D`, `TExposed`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

#### Call Signature

> **decorate**<`D`>(`values`, `options`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `D`, `TExposed` & `D`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

Defined in: composer/index.d.ts:285

##### Type Parameters

| Type Parameter |
| ------ |
| `D` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `values` | `D` |
| `options` | { `as`: `"global"` | `"scoped"`; } |
| `options.as` | `"global"` | `"scoped"` |

##### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `D`, `TExposed` & `D`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

***

### derive()

#### Call Signature

> **derive**<`D`>(`handler`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `D`, `TExposed`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

Defined in: composer/index.d.ts:288

##### Type Parameters

| Type Parameter |
| ------ |
| `D` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`DeriveHandler`](../type-aliases/DeriveHandler.md)<`TOut`, `D`> |

##### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `D`, `TExposed`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

#### Call Signature

> **derive**<`D`>(`handler`, `options`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `D`, `TExposed` & `D`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

Defined in: composer/index.d.ts:289

##### Type Parameters

| Type Parameter |
| ------ |
| `D` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`DeriveHandler`](../type-aliases/DeriveHandler.md)<`TOut`, `D`> |
| `options` | { `as`: `"global"` | `"scoped"`; } |
| `options.as` | `"global"` | `"scoped"` |

##### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `D`, `TExposed` & `D`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

#### Call Signature

> **derive**<`E`, `D`>(`event`, `handler`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut`, `TExposed`, `TDerives` & `{ [K in string]: D }`, `TMethods`, `TMacros`> & `TMethods`

Defined in: composer/index.d.ts:292

##### Type Parameters

| Type Parameter |
| ------ |
| `E` *extends* `string` |
| `D` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | [`MaybeArray`](../type-aliases/MaybeArray.md)<`E`> |
| `handler` | [`DeriveHandler`](../type-aliases/DeriveHandler.md)<`ResolveEventCtx`<`TOut`, `TEventMap`, `TDerives`, `E`>, `D`> |

##### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut`, `TExposed`, `TDerives` & `{ [K in string]: D }`, `TMethods`, `TMacros`> & `TMethods`

***

### error()

> **error**(`kind`, `errorClass`): `this`

Defined in: composer/index.d.ts:279

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `kind` | `string` |
| `errorClass` | {(...`args`): `any`; `prototype`: `Error`; } |
| `errorClass.prototype` | `Error` |

#### Returns

`this`

***

### extend()

#### Call Signature

> **extend**<`UIn`, `UOut`, `UExposed`, `UDerives`, `UMacros`>(`other`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `UExposed`, `TExposed`, `TDerives` & `UDerives`, `TMethods`, `TMacros` & `UMacros`> & `TMethods`

Defined in: composer/index.d.ts:297

##### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `UIn` *extends* `object` | - |
| `UOut` *extends* `object` | - |
| `UExposed` *extends* `object` | - |
| `UDerives` *extends* `Record`<`string`, `object`> | - |
| `UMacros` *extends* [`MacroDefinitions`](../type-aliases/MacroDefinitions.md) | `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `other` | `EventComposer`<`TBase`, `TEventMap`, `UIn`, `UOut`, `UExposed`, `UDerives`, `any`, `UMacros`> |

##### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `UExposed`, `TExposed`, `TDerives` & `UDerives`, `TMethods`, `TMacros` & `UMacros`> & `TMethods`

#### Call Signature

> **extend**<`UIn`, `UOut`, `UExposed`, `UMacros`>(`other`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `UExposed`, `TExposed`, `TDerives`, `TMethods`, `TMacros` & `UMacros`> & `TMethods`

Defined in: composer/index.d.ts:298

##### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `UIn` *extends* `object` | - |
| `UOut` *extends* `object` | - |
| `UExposed` *extends* `object` | - |
| `UMacros` *extends* [`MacroDefinitions`](../type-aliases/MacroDefinitions.md) | `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `other` | [`Composer`](../classes/Composer.md)<`UIn`, `UOut`, `UExposed`, `UMacros`> |

##### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `UExposed`, `TExposed`, `TDerives`, `TMethods`, `TMacros` & `UMacros`> & `TMethods`

#### Call Signature

> **extend**<`P`>(`plugin`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `P`\[`"_"`]\[`"Derives"`]\[`"global"`], `TExposed`, `TDerives` & `Omit`<`P`\[`"_"`]\[`"Derives"`], `"global"`>, `TMethods`, `TMacros` & `P`\[`"_"`]\[`"Macros"`]>

Defined in: gramio/index.d.ts:54

##### Type Parameters

| Type Parameter |
| ------ |
| `P` *extends* [`AnyPlugin`](../../../../gramio/type-aliases/AnyPlugin.md) |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `plugin` | `P` |

##### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `P`\[`"_"`]\[`"Derives"`]\[`"global"`], `TExposed`, `TDerives` & `Omit`<`P`\[`"_"`]\[`"Derives"`], `"global"`>, `TMethods`, `TMacros` & `P`\[`"_"`]\[`"Macros"`]>

***

### fork()

> **fork**(...`middleware`): `this`

Defined in: composer/index.d.ts:275

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`middleware` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`>\[] |

#### Returns

`this`

***

### group()

> **group**(`fn`): `this`

Defined in: composer/index.d.ts:283

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `fn` | (`composer`) => `void` |

#### Returns

`this`

***

### guard()

#### Call Signature

> **guard**<`Narrowing`>(`predicate`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `Narrowing`, `TExposed`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

Defined in: composer/index.d.ts:269

##### Type Parameters

| Type Parameter |
| ------ |
| `Narrowing` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `predicate` | (`context`) => `context is Narrowing` |

##### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `Narrowing`, `TExposed`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

#### Call Signature

> **guard**<`S`>(`predicate`, ...`middleware`): `this`

Defined in: composer/index.d.ts:270

##### Type Parameters

| Type Parameter |
| ------ |
| `S` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `predicate` | (`context`) => `context is S` | (`context`) => `boolean` | `Promise`<`boolean`> |
| ...`middleware` | [`Middleware`](../type-aliases/Middleware.md)<`any`>\[] |

##### Returns

`this`

***

### inspect()

> **inspect**(): [`MiddlewareInfo`](MiddlewareInfo.md)\[]

Defined in: composer/index.d.ts:303

#### Returns

[`MiddlewareInfo`](MiddlewareInfo.md)\[]

***

### invalidate()

> **invalidate**(): `void`

Defined in: composer/index.d.ts:324

#### Returns

`void`

***

### lazy()

> **lazy**(`factory`): `this`

Defined in: composer/index.d.ts:277

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `factory` | [`LazyFactory`](../type-aliases/LazyFactory.md)<`TOut`> |

#### Returns

`this`

***

### macro()

#### Call Signature

> **macro**<`Name`, `TDef`>(`name`, `definition`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut`, `TExposed`, `TDerives`, `TMethods`, `TMacros` & `Record`<`Name`, `TDef`>> & `TMethods`

Defined in: composer/index.d.ts:300

Register a single named macro

##### Type Parameters

| Type Parameter |
| ------ |
| `Name` *extends* `string` |
| `TDef` *extends* [`MacroDef`](../type-aliases/MacroDef.md)<`any`, `any`> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `Name` |
| `definition` | `TDef` |

##### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut`, `TExposed`, `TDerives`, `TMethods`, `TMacros` & `Record`<`Name`, `TDef`>> & `TMethods`

#### Call Signature

> **macro**<`TDefs`>(`definitions`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut`, `TExposed`, `TDerives`, `TMethods`, `TMacros` & `TDefs`> & `TMethods`

Defined in: composer/index.d.ts:302

Register multiple macros at once

##### Type Parameters

| Type Parameter |
| ------ |
| `TDefs` *extends* `Record`<`string`, [`MacroDef`](../type-aliases/MacroDef.md)<`any`, `any`>> |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `definitions` | `TDefs` |

##### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut`, `TExposed`, `TDerives`, `TMethods`, `TMacros` & `TDefs`> & `TMethods`

***

### on()

#### Call Signature

> **on**<`Narrowing`>(`filter`, `handler`): `this`

Defined in: composer/index.d.ts:262

##### Type Parameters

| Type Parameter |
| ------ |
| `Narrowing` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `filter` | (`ctx`) => `ctx is Narrowing` |
| `handler` | [`Middleware`](../type-aliases/Middleware.md)<`ResolveEventCtx`<`TOut`, `TEventMap`, `TDerives`, [`CompatibleEvents`](../type-aliases/CompatibleEvents.md)<`TEventMap`, `Narrowing`>> & `Narrowing`> |

##### Returns

`this`

#### Call Signature

> **on**(`filter`, `handler`): `this`

Defined in: composer/index.d.ts:263

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `filter` | (`ctx`) => `boolean` |
| `handler` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`> |

##### Returns

`this`

#### Call Signature

> **on**<`E`, `Narrowing`>(`event`, `filter`, `handler`): `this`

Defined in: composer/index.d.ts:264

##### Type Parameters

| Type Parameter |
| ------ |
| `E` *extends* `string` |
| `Narrowing` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | [`MaybeArray`](../type-aliases/MaybeArray.md)<`E`> |
| `filter` | (`ctx`) => `ctx is Narrowing` |
| `handler` | [`Middleware`](../type-aliases/Middleware.md)<`ResolveEventCtx`<`TOut`, `TEventMap`, `TDerives`, `E`> & `Narrowing`> |

##### Returns

`this`

#### Call Signature

> **on**<`E`>(`event`, `filter`, `handler`): `this`

Defined in: composer/index.d.ts:265

##### Type Parameters

| Type Parameter |
| ------ |
| `E` *extends* `string` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | [`MaybeArray`](../type-aliases/MaybeArray.md)<`E`> |
| `filter` | (`ctx`) => `boolean` |
| `handler` | [`Middleware`](../type-aliases/Middleware.md)<`ResolveEventCtx`<`TOut`, `TEventMap`, `TDerives`, `E`>> |

##### Returns

`this`

#### Call Signature

> **on**<`E`, `Patch`>(`event`, `handler`): `this`

Defined in: composer/index.d.ts:266

##### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `E` *extends* `string` | - |
| `Patch` *extends* `object` | `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | [`MaybeArray`](../type-aliases/MaybeArray.md)<`E`> |
| `handler` | [`Middleware`](../type-aliases/Middleware.md)<`ResolveEventCtx`<`TOut`, `TEventMap`, `TDerives`, `E`> & `Patch`> |

##### Returns

`this`

***

### onError()

> **onError**(`handler`): `this`

Defined in: composer/index.d.ts:278

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`ErrorHandler`](../type-aliases/ErrorHandler.md)<`TOut`> |

#### Returns

`this`

***

### route()

#### Call Signature

> **route**<`K`>(`router`, `cases`, `fallback?`): `this`

Defined in: composer/index.d.ts:272

##### Type Parameters

| Type Parameter |
| ------ |
| `K` *extends* `string` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `router` | (`context`) => `K` | `Promise`<`K`> |
| `cases` | `Partial`<`Record`<`K`, (`composer`) => [`Composer`](../classes/Composer.md)<`any`, `any`, `any`>>> |
| `fallback?` | (`composer`) => [`Composer`](../classes/Composer.md)<`any`, `any`, `any`> |

##### Returns

`this`

#### Call Signature

> **route**<`K`>(`router`, `builder`): `this`

Defined in: composer/index.d.ts:273

##### Type Parameters

| Type Parameter |
| ------ |
| `K` *extends* `string` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `router` | (`context`) => `K` | `Promise`<`K`> |
| `builder` | (`route`) => `void` |

##### Returns

`this`

#### Call Signature

> **route**<`K`>(`router`, `cases`, `fallback?`): `this`

Defined in: composer/index.d.ts:274

##### Type Parameters

| Type Parameter |
| ------ |
| `K` *extends* `string` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `router` | (`context`) => `K` | `Promise`<`K`> |
| `cases` | `Partial`<`Record`<`K`, [`Middleware`](../type-aliases/Middleware.md)<`TOut`> | [`Middleware`](../type-aliases/Middleware.md)<`TOut`>\[] | [`Composer`](../classes/Composer.md)<`any`, `any`, `any`>>> |
| `fallback?` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`> | [`Middleware`](../type-aliases/Middleware.md)<`TOut`>\[] | [`Composer`](../classes/Composer.md)<`any`, `any`, `any`, { }> |

##### Returns

`this`

***

### run()

> **run**(`context`, `next?`): `Promise`<`void`>

Defined in: composer/index.d.ts:306

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | `TIn` |
| `next?` | [`Next`](../type-aliases/Next.md) |

#### Returns

`Promise`<`void`>

***

### tap()

> **tap**(...`middleware`): `this`

Defined in: composer/index.d.ts:276

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`middleware` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`>\[] |

#### Returns

`this`

***

### trace()

> **trace**(`handler`): `this`

Defined in: composer/index.d.ts:304

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`TraceHandler`](../type-aliases/TraceHandler.md) |

#### Returns

`this`

***

### use()

#### Call Signature

> **use**<`Patch`>(`handler`): `this`

Defined in: composer/index.d.ts:267

##### Type Parameters

| Type Parameter |
| ------ |
| `Patch` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`Middleware`](../type-aliases/Middleware.md)<`TOut` & `Patch`> |

##### Returns

`this`

#### Call Signature

> **use**(...`middleware`): `this`

Defined in: composer/index.d.ts:268

##### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`middleware` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`>\[] |

##### Returns

`this`

***

### when()

> **when**<`UOut`>(`condition`, `fn`): `EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `Partial`<`Omit`<`UOut`, keyof `TOut`>>, `TExposed`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

Defined in: composer/index.d.ts:295

#### Type Parameters

| Type Parameter |
| ------ |
| `UOut` *extends* `object` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `condition` | `boolean` |
| `fn` | (`composer`) => [`Composer`](../classes/Composer.md)<`TOut`, `UOut`, `any`> |

#### Returns

`EventComposer`<`TBase`, `TEventMap`, `TIn`, `TOut` & `Partial`<`Omit`<`UOut`, keyof `TOut`>>, `TExposed`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

---

---
url: 'https://gramio.dev/api/composer/interfaces/EventComposerConstructor.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / EventComposerConstructor

# Interface: EventComposerConstructor\<TBase, TEventMap, TMethods>

Defined in: composer/index.d.ts:326

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `TBase` *extends* `object` | - |
| `TEventMap` *extends* `Record`<`string`, `TBase`> | - |
| `TMethods` *extends* `Record`<`string`, (...`args`) => `any`> | `object` |

## Constructors

### Constructor

> **new EventComposerConstructor**<`TIn`, `TOut`, `TExposed`, `TDerives`, `TMacros`>(`options?`): [`EventComposer`](EventComposer.md)<`TBase`, `TEventMap`, `TIn`, `TOut`, `TExposed`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

Defined in: composer/index.d.ts:327

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ComposerOptions`](ComposerOptions.md) |

#### Returns

[`EventComposer`](EventComposer.md)<`TBase`, `TEventMap`, `TIn`, `TOut`, `TExposed`, `TDerives`, `TMethods`, `TMacros`> & `TMethods`

---

---
url: 'https://gramio.dev/api/gramio/interfaces/ExportChatInviteLinkParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / ExportChatInviteLinkParams

# Interface: ExportChatInviteLinkParams

Defined in: @gramio/types/out/params.d.ts:1951

Params object for [exportChatInviteLink](APIMethods.md#exportchatinvitelink) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1955 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/ForwardMessageParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / ForwardMessageParams

# Interface: ForwardMessageParams

Defined in: @gramio/types/out/params.d.ts:165

Params object for [forwardMessage](APIMethods.md#forwardmessage) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:169 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat | @gramio/types/out/params.d.ts:177 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:189 |
|  `from_chat_id` | `string` | `number` | Unique identifier for the chat where the original message was sent (or channel username in the format `@channelusername`) | @gramio/types/out/params.d.ts:181 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; only available when forwarding to private chats | @gramio/types/out/params.d.ts:197 |
|  `message_id` | `number` | Message identifier in the chat specified in *from\_chat\_id* | @gramio/types/out/params.d.ts:205 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:173 |
|  `protect_content?` | `boolean` | Protects the contents of the forwarded message from forwarding and saving | @gramio/types/out/params.d.ts:193 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only | @gramio/types/out/params.d.ts:201 |
|  `video_start_timestamp?` | `number` | New start timestamp for the forwarded video in the message | @gramio/types/out/params.d.ts:185 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/ForwardMessagesParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / ForwardMessagesParams

# Interface: ForwardMessagesParams

Defined in: @gramio/types/out/params.d.ts:211

Params object for [forwardMessages](APIMethods.md#forwardmessages) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:215 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat | @gramio/types/out/params.d.ts:223 |
|  `disable_notification?` | `boolean` | Sends the messages [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:235 |
|  `from_chat_id` | `string` | `number` | Unique identifier for the chat where the original messages were sent (or channel username in the format `@channelusername`) | @gramio/types/out/params.d.ts:227 |
|  `message_ids` | `number`\[] | A JSON-serialized list of 1-100 identifiers of messages in the chat *from\_chat\_id* to forward. The identifiers must be specified in a strictly increasing order. | @gramio/types/out/params.d.ts:231 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:219 |
|  `protect_content?` | `boolean` | Protects the contents of the forwarded messages from forwarding and saving | @gramio/types/out/params.d.ts:239 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetBusinessAccountGiftsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetBusinessAccountGiftsParams

# Interface: GetBusinessAccountGiftsParams

Defined in: @gramio/types/out/params.d.ts:2945

Params object for [getBusinessAccountGifts](APIMethods.md#getbusinessaccountgifts) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:2949 |
|  `exclude_from_blockchain?` | `boolean` | Pass *True* to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram | @gramio/types/out/params.d.ts:2977 |
|  `exclude_limited_non_upgradable?` | `boolean` | Pass *True* to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique | @gramio/types/out/params.d.ts:2969 |
|  `exclude_limited_upgradable?` | `boolean` | Pass *True* to exclude gifts that can be purchased a limited number of times and can be upgraded to unique | @gramio/types/out/params.d.ts:2965 |
|  `exclude_saved?` | `boolean` | Pass *True* to exclude gifts that are saved to the account's profile page | @gramio/types/out/params.d.ts:2957 |
|  `exclude_unique?` | `boolean` | Pass *True* to exclude unique gifts | @gramio/types/out/params.d.ts:2973 |
|  `exclude_unlimited?` | `boolean` | Pass *True* to exclude gifts that can be purchased an unlimited number of times | @gramio/types/out/params.d.ts:2961 |
|  `exclude_unsaved?` | `boolean` | Pass *True* to exclude gifts that aren't saved to the account's profile page | @gramio/types/out/params.d.ts:2953 |
|  `limit?` | `number` | The maximum number of gifts to be returned; 1-100. Defaults to 100 | @gramio/types/out/params.d.ts:2989 |
|  `offset?` | `string` | Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results | @gramio/types/out/params.d.ts:2985 |
|  `sort_by_price?` | `boolean` | Pass *True* to sort results by gift price instead of send date. Sorting is applied before pagination. | @gramio/types/out/params.d.ts:2981 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/GetBusinessAccountStarBalanceParams.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetBusinessAccountStarBalanceParams

# Interface: GetBusinessAccountStarBalanceParams

Defined in: @gramio/types/out/params.d.ts:2921

Params object for [getBusinessAccountStarBalance](APIMethods.md#getbusinessaccountstarbalance) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:2925 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetBusinessConnectionParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetBusinessConnectionParams

# Interface: GetBusinessConnectionParams

Defined in: @gramio/types/out/params.d.ts:2493

Params object for [getBusinessConnection](APIMethods.md#getbusinessconnection) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:2497 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetChatAdministratorsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetChatAdministratorsParams

# Interface: GetChatAdministratorsParams

Defined in: @gramio/types/out/params.d.ts:2221

Params object for [getChatAdministrators](APIMethods.md#getchatadministrators) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup or channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2225 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetChatGiftsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetChatGiftsParams

# Interface: GetChatGiftsParams

Defined in: @gramio/types/out/params.d.ts:3037

Params object for [getChatGifts](APIMethods.md#getchatgifts) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:3041 |
|  `exclude_from_blockchain?` | `boolean` | Pass *True* to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram | @gramio/types/out/params.d.ts:3065 |
|  `exclude_limited_non_upgradable?` | `boolean` | Pass *True* to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique | @gramio/types/out/params.d.ts:3061 |
|  `exclude_limited_upgradable?` | `boolean` | Pass *True* to exclude gifts that can be purchased a limited number of times and can be upgraded to unique | @gramio/types/out/params.d.ts:3057 |
|  `exclude_saved?` | `boolean` | Pass *True* to exclude gifts that are saved to the chat's profile page. Always *False*, unless the bot has the *can\_post\_messages* administrator right in the channel. | @gramio/types/out/params.d.ts:3049 |
|  `exclude_unique?` | `boolean` | Pass *True* to exclude unique gifts | @gramio/types/out/params.d.ts:3069 |
|  `exclude_unlimited?` | `boolean` | Pass *True* to exclude gifts that can be purchased an unlimited number of times | @gramio/types/out/params.d.ts:3053 |
|  `exclude_unsaved?` | `boolean` | Pass *True* to exclude gifts that aren't saved to the chat's profile page. Always *True*, unless the bot has the *can\_post\_messages* administrator right in the channel. | @gramio/types/out/params.d.ts:3045 |
|  `limit?` | `number` | The maximum number of gifts to be returned; 1-100. Defaults to 100 | @gramio/types/out/params.d.ts:3081 |
|  `offset?` | `string` | Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results | @gramio/types/out/params.d.ts:3077 |
|  `sort_by_price?` | `boolean` | Pass *True* to sort results by gift price instead of send date. Sorting is applied before pagination. | @gramio/types/out/params.d.ts:3073 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetChatMemberCountParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetChatMemberCountParams

# Interface: GetChatMemberCountParams

Defined in: @gramio/types/out/params.d.ts:2231

Params object for [getChatMemberCount](APIMethods.md#getchatmembercount) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup or channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2235 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetChatMemberParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetChatMemberParams

# Interface: GetChatMemberParams

Defined in: @gramio/types/out/params.d.ts:2241

Params object for [getChatMember](APIMethods.md#getchatmember) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup or channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2245 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:2249 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetChatMenuButtonParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetChatMenuButtonParams

# Interface: GetChatMenuButtonParams

Defined in: @gramio/types/out/params.d.ts:2645

Params object for [getChatMenuButton](APIMethods.md#getchatmenubutton) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id?` | `number` | Unique identifier for the target private chat. If not specified, default bot's menu button will be returned | @gramio/types/out/params.d.ts:2649 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetChatParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetChatParams

# Interface: GetChatParams

Defined in: @gramio/types/out/params.d.ts:2211

Params object for [getChat](APIMethods.md#getchat) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup or channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2215 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetCustomEmojiStickersParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetCustomEmojiStickersParams

# Interface: GetCustomEmojiStickersParams

Defined in: @gramio/types/out/params.d.ts:3689

Params object for [getCustomEmojiStickers](APIMethods.md#getcustomemojistickers) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `custom_emoji_ids` | `string`\[] | A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified. | @gramio/types/out/params.d.ts:3693 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetFileParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetFileParams

# Interface: GetFileParams

Defined in: @gramio/types/out/params.d.ts:1711

Params object for [getFile](APIMethods.md#getfile) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `file_id` | `string` | File identifier to get information about | @gramio/types/out/params.d.ts:1715 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetGameHighScoresParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetGameHighScoresParams

# Interface: GetGameHighScoresParams

Defined in: @gramio/types/out/params.d.ts:4401

Params object for [getGameHighScores](APIMethods.md#getgamehighscores) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id?` | `number` | Required if *inline\_message\_id* is not specified. Unique identifier for the target chat | @gramio/types/out/params.d.ts:4409 |
|  `inline_message_id?` | `string` | Required if *chat\_id* and *message\_id* are not specified. Identifier of the inline message | @gramio/types/out/params.d.ts:4417 |
|  `message_id?` | `number` | Required if *inline\_message\_id* is not specified. Identifier of the sent message | @gramio/types/out/params.d.ts:4413 |
|  `user_id` | `number` | Target user id | @gramio/types/out/params.d.ts:4405 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetMyCommandsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetMyCommandsParams

# Interface: GetMyCommandsParams

Defined in: @gramio/types/out/params.d.ts:2535

Params object for [getMyCommands](APIMethods.md#getmycommands) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `language_code?` | `string` | A two-letter ISO 639-1 language code or an empty string | @gramio/types/out/params.d.ts:2543 |
|  `scope?` | [`TelegramBotCommandScope`](../type-aliases/TelegramBotCommandScope.md) | A JSON-serialized object, describing scope of users. Defaults to [BotCommandScopeDefault](https://core.telegram.org/bots/api#botcommandscopedefault). | @gramio/types/out/params.d.ts:2539 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/GetMyDefaultAdministratorRightsParams.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetMyDefaultAdministratorRightsParams

# Interface: GetMyDefaultAdministratorRightsParams

Defined in: @gramio/types/out/params.d.ts:2669

Params object for [getMyDefaultAdministratorRights](APIMethods.md#getmydefaultadministratorrights) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `for_channels?` | `boolean` | Pass *True* to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned. | @gramio/types/out/params.d.ts:2673 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetMyDescriptionParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetMyDescriptionParams

# Interface: GetMyDescriptionParams

Defined in: @gramio/types/out/params.d.ts:2587

Params object for [getMyDescription](APIMethods.md#getmydescription) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `language_code?` | `string` | A two-letter ISO 639-1 language code or an empty string | @gramio/types/out/params.d.ts:2591 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetMyNameParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetMyNameParams

# Interface: GetMyNameParams

Defined in: @gramio/types/out/params.d.ts:2563

Params object for [getMyName](APIMethods.md#getmyname) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `language_code?` | `string` | A two-letter ISO 639-1 language code or an empty string | @gramio/types/out/params.d.ts:2567 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetMyShortDescriptionParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetMyShortDescriptionParams

# Interface: GetMyShortDescriptionParams

Defined in: @gramio/types/out/params.d.ts:2611

Params object for [getMyShortDescription](APIMethods.md#getmyshortdescription) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `language_code?` | `string` | A two-letter ISO 639-1 language code or an empty string | @gramio/types/out/params.d.ts:2615 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetStarTransactionsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetStarTransactionsParams

# Interface: GetStarTransactionsParams

Defined in: @gramio/types/out/params.d.ts:4259

Params object for [getStarTransactions](APIMethods.md#getstartransactions) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `limit?` | `number` | The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100. | @gramio/types/out/params.d.ts:4267 |
|  `offset?` | `number` | Number of transactions to skip in the response | @gramio/types/out/params.d.ts:4263 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetStickerSetParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetStickerSetParams

# Interface: GetStickerSetParams

Defined in: @gramio/types/out/params.d.ts:3679

Params object for [getStickerSet](APIMethods.md#getstickerset) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `name` | `string` | Name of the sticker set | @gramio/types/out/params.d.ts:3683 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetUpdatesParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetUpdatesParams

# Interface: GetUpdatesParams

Defined in: @gramio/types/out/params.d.ts:22

Params object for [getUpdates](APIMethods.md#getupdates) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allowed_updates?` | (`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"business_connection"` | `"business_message"` | `"edited_business_message"` | `"deleted_business_messages"` | `"message_reaction"` | `"message_reaction_count"` | `"inline_query"` | `"chosen_inline_result"` | `"callback_query"` | `"shipping_query"` | `"pre_checkout_query"` | `"purchased_paid_media"` | `"poll"` | `"poll_answer"` | `"my_chat_member"` | `"chat_member"` | `"chat_join_request"` | `"chat_boost"` | `"removed_chat_boost"`)\[] | A JSON-serialized list of the update types you want your bot to receive. For example, specify `["message", "edited_channel_post", "callback_query"]` to only receive updates of these types. See [Update](https://core.telegram.org/bots/api#update) for a complete list of available update types. Specify an empty list to receive all update types except *chat\_member*, *message\_reaction*, and *message\_reaction\_count* (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time. | @gramio/types/out/params.d.ts:40 |
|  `limit?` | `number` | Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100. | @gramio/types/out/params.d.ts:30 |
|  `offset?` | `number` | Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as [getUpdates](https://core.telegram.org/bots/api#getupdates) is called with an *offset* higher than its *update\_id*. The negative offset can be specified to retrieve updates starting from *-offset* update from the end of the updates queue. All previous updates will be forgotten. | @gramio/types/out/params.d.ts:26 |
|  `timeout?` | `number` | Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. | @gramio/types/out/params.d.ts:34 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetUserChatBoostsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetUserChatBoostsParams

# Interface: GetUserChatBoostsParams

Defined in: @gramio/types/out/params.d.ts:2479

Params object for [getUserChatBoosts](APIMethods.md#getuserchatboosts) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the chat or username of the channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2483 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:2487 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetUserGiftsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetUserGiftsParams

# Interface: GetUserGiftsParams

Defined in: @gramio/types/out/params.d.ts:2995

Params object for [getUserGifts](APIMethods.md#getusergifts) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `exclude_from_blockchain?` | `boolean` | Pass *True* to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram | @gramio/types/out/params.d.ts:3015 |
|  `exclude_limited_non_upgradable?` | `boolean` | Pass *True* to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique | @gramio/types/out/params.d.ts:3011 |
|  `exclude_limited_upgradable?` | `boolean` | Pass *True* to exclude gifts that can be purchased a limited number of times and can be upgraded to unique | @gramio/types/out/params.d.ts:3007 |
|  `exclude_unique?` | `boolean` | Pass *True* to exclude unique gifts | @gramio/types/out/params.d.ts:3019 |
|  `exclude_unlimited?` | `boolean` | Pass *True* to exclude gifts that can be purchased an unlimited number of times | @gramio/types/out/params.d.ts:3003 |
|  `limit?` | `number` | The maximum number of gifts to be returned; 1-100. Defaults to 100 | @gramio/types/out/params.d.ts:3031 |
|  `offset?` | `string` | Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results | @gramio/types/out/params.d.ts:3027 |
|  `sort_by_price?` | `boolean` | Pass *True* to sort results by gift price instead of send date. Sorting is applied before pagination. | @gramio/types/out/params.d.ts:3023 |
|  `user_id` | `number` | Unique identifier of the user | @gramio/types/out/params.d.ts:2999 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetUserProfileAudiosParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetUserProfileAudiosParams

# Interface: GetUserProfileAudiosParams

Defined in: @gramio/types/out/params.d.ts:1675

Params object for [getUserProfileAudios](APIMethods.md#getuserprofileaudios) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `limit?` | `number` | Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100. | @gramio/types/out/params.d.ts:1687 |
|  `offset?` | `number` | Sequential number of the first audio to be returned. By default, all audios are returned. | @gramio/types/out/params.d.ts:1683 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:1679 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GetUserProfilePhotosParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GetUserProfilePhotosParams

# Interface: GetUserProfilePhotosParams

Defined in: @gramio/types/out/params.d.ts:1657

Params object for [getUserProfilePhotos](APIMethods.md#getuserprofilephotos) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `limit?` | `number` | Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. | @gramio/types/out/params.d.ts:1669 |
|  `offset?` | `number` | Sequential number of the first photo to be returned. By default, all photos are returned. | @gramio/types/out/params.d.ts:1665 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:1661 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/GiftPremiumSubscriptionParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GiftPremiumSubscriptionParams

# Interface: GiftPremiumSubscriptionParams

Defined in: @gramio/types/out/params.d.ts:2715

Params object for [giftPremiumSubscription](APIMethods.md#giftpremiumsubscription) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `month_count` | [`GiftPremiumSubscriptionMonthCount`](../type-aliases/GiftPremiumSubscriptionMonthCount.md) | Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12 | @gramio/types/out/params.d.ts:2723 |
|  `star_count` | `number` | Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months | @gramio/types/out/params.d.ts:2727 |
|  `text?` | `string` | { `toString`: `string`; } | Text that will be shown along with the service message about the subscription; 0-128 characters | @gramio/types/out/params.d.ts:2731 |
|  `text_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of *text\_parse\_mode*. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom\_emoji” are ignored. | @gramio/types/out/params.d.ts:2739 |
|  `text_parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the text. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom\_emoji” are ignored. | @gramio/types/out/params.d.ts:2735 |
|  `user_id` | `number` | Unique identifier of the target user who will receive a Telegram Premium subscription | @gramio/types/out/params.d.ts:2719 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/HideGeneralForumTopicParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / HideGeneralForumTopicParams

# Interface: HideGeneralForumTopicParams

Defined in: @gramio/types/out/params.d.ts:2421

Params object for [hideGeneralForumTopic](APIMethods.md#hidegeneralforumtopic) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2425 |

---

---
url: 'https://gramio.dev/api/i18n/interfaces/I18nOptions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / I18nOptions

# Interface: I18nOptions\<Languages, PrimaryLanguage>

Defined in: i18n/index.d.ts:25

## Type Parameters

| Type Parameter |
| ------ |
| `Languages` *extends* [`LanguagesMap`](../type-aliases/LanguagesMap.md) |
| `PrimaryLanguage` *extends* keyof `Languages` |

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `languages` | `Languages` | i18n/index.d.ts:26 |
|  `primaryLanguage` | `PrimaryLanguage` | i18n/index.d.ts:27 |

---

---
url: 'https://gramio.dev/api/scenes/interfaces/InActiveSceneHandlerReturn.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / InActiveSceneHandlerReturn

# Interface: InActiveSceneHandlerReturn\<Params, State, ExitData>

Defined in: scenes/index.d.ts:185

## Extends

* [`EnterExit`](EnterExit.md)

## Extended by

* [`InUnknownScene`](InUnknownScene.md)

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Params` | - |
| `State` *extends* [`StateTypesDefault`](../type-aliases/StateTypesDefault.md) | - |
| `ExitData` *extends* `Record`<`string`, `unknown`> | `Record`<`string`, `unknown`> |

## Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
|  `enter` | [`SceneEnterHandler`](../type-aliases/SceneEnterHandler.md) | [`EnterExit`](EnterExit.md).[`enter`](EnterExit.md#enter) | scenes/index.d.ts:174 |
|  `enterSub` | [`SceneEnterHandler`](../type-aliases/SceneEnterHandler.md) | - | scenes/index.d.ts:191 |
|  `exit` | () => [`MaybePromise`](../../../../gramio/type-aliases/MaybePromise.md)<`boolean`> | [`EnterExit`](EnterExit.md).[`exit`](EnterExit.md#exit) | scenes/index.d.ts:175 |
|  `exitSub` | (`returnData?`) => `Promise`<`void`> | - | scenes/index.d.ts:192 |
|  `params` | `Params` | - | scenes/index.d.ts:187 |
|  `reenter` | () => `Promise`<`void`> | - | scenes/index.d.ts:190 |
|  `state` | `State` | - | scenes/index.d.ts:186 |
|  `step` | [`SceneStepReturn`](../type-aliases/SceneStepReturn.md) | - | scenes/index.d.ts:189 |
|  `update` | <`T`>(`state`, `options?`) => `Promise`<[`UpdateData`](../type-aliases/UpdateData.md)<`T`>> | - | scenes/index.d.ts:188 |

---

---
url: 'https://gramio.dev/api/scenes/interfaces/InUnknownScene.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / InUnknownScene

# Interface: InUnknownScene\<Params, State, GlobalScene>

Defined in: scenes/index.d.ts:194

## Extends

* [`InActiveSceneHandlerReturn`](InActiveSceneHandlerReturn.md)<`Params`, `State`>

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Params` | - |
| `State` *extends* [`StateTypesDefault`](../type-aliases/StateTypesDefault.md) | - |
| `GlobalScene` *extends* [`AnyScene`](../type-aliases/AnyScene.md) | `null` | `null` |

## Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
|  `enter` | [`SceneEnterHandler`](../type-aliases/SceneEnterHandler.md) | [`InActiveSceneHandlerReturn`](InActiveSceneHandlerReturn.md).[`enter`](InActiveSceneHandlerReturn.md#enter) | scenes/index.d.ts:174 |
|  `enterSub` | [`SceneEnterHandler`](../type-aliases/SceneEnterHandler.md) | [`InActiveSceneHandlerReturn`](InActiveSceneHandlerReturn.md).[`enterSub`](InActiveSceneHandlerReturn.md#entersub) | scenes/index.d.ts:191 |
|  `exit` | () => [`MaybePromise`](../../../../gramio/type-aliases/MaybePromise.md)<`boolean`> | [`InActiveSceneHandlerReturn`](InActiveSceneHandlerReturn.md).[`exit`](InActiveSceneHandlerReturn.md#exit) | scenes/index.d.ts:175 |
|  `exitSub` | (`returnData?`) => `Promise`<`void`> | [`InActiveSceneHandlerReturn`](InActiveSceneHandlerReturn.md).[`exitSub`](InActiveSceneHandlerReturn.md#exitsub) | scenes/index.d.ts:192 |
|  `params` | `Params` | [`InActiveSceneHandlerReturn`](InActiveSceneHandlerReturn.md).[`params`](InActiveSceneHandlerReturn.md#params-1) | scenes/index.d.ts:187 |
|  `reenter` | () => `Promise`<`void`> | [`InActiveSceneHandlerReturn`](InActiveSceneHandlerReturn.md).[`reenter`](InActiveSceneHandlerReturn.md#reenter) | scenes/index.d.ts:190 |
|  `state` | `State` | [`InActiveSceneHandlerReturn`](InActiveSceneHandlerReturn.md).[`state`](InActiveSceneHandlerReturn.md#state-1) | scenes/index.d.ts:186 |
|  `step` | [`SceneStepReturn`](../type-aliases/SceneStepReturn.md) | [`InActiveSceneHandlerReturn`](InActiveSceneHandlerReturn.md).[`step`](InActiveSceneHandlerReturn.md#step) | scenes/index.d.ts:189 |
|  `update` | <`T`>(`state`, `options?`) => `Promise`<[`UpdateData`](../type-aliases/UpdateData.md)<`T`>> | [`InActiveSceneHandlerReturn`](InActiveSceneHandlerReturn.md).[`update`](InActiveSceneHandlerReturn.md#update) | scenes/index.d.ts:188 |

## Methods

### is()

> **is**<`Scene`>(`scene`): `this is InUnknownScene<Scene["~"]["params"], Scene["~"]["state"], Scene>`

Defined in: scenes/index.d.ts:195

#### Type Parameters

| Type Parameter |
| ------ |
| `Scene` *extends* [`AnyScene`](../type-aliases/AnyScene.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `scene` | `Scene` |

#### Returns

`this is InUnknownScene<Scene["~"]["params"], Scene["~"]["state"], Scene>`

---

---
url: 'https://gramio.dev/api/keyboards/interfaces/KeyboardFeatureFlags.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / KeyboardFeatureFlags

# Interface: KeyboardFeatureFlags

Defined in: keyboards/index.d.ts:7

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `enableSetterKeyboardHelpers` | `boolean` | keyboards/index.d.ts:8 |

---

---
url: 'https://gramio.dev/api/keyboards/interfaces/KeyboardHelperColumns.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / KeyboardHelperColumns

# Interface: KeyboardHelperColumns

Defined in: keyboards/index.d.ts:21

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `columns` | `number` | keyboards/index.d.ts:23 |
|  `type` | `"columns"` | keyboards/index.d.ts:22 |

---

---
url: 'https://gramio.dev/api/keyboards/interfaces/KeyboardHelperFilter.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / KeyboardHelperFilter

# Interface: KeyboardHelperFilter\<T>

Defined in: keyboards/index.d.ts:29

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `fn` | [`ButtonsIterator`](../type-aliases/ButtonsIterator.md)<`T`> | keyboards/index.d.ts:31 |
|  `type` | `"filter"` | keyboards/index.d.ts:30 |

---

---
url: 'https://gramio.dev/api/keyboards/interfaces/KeyboardHelperPattern.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / KeyboardHelperPattern

# Interface: KeyboardHelperPattern

Defined in: keyboards/index.d.ts:33

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `pattern` | `number`\[] | keyboards/index.d.ts:35 |
|  `type` | `"pattern"` | keyboards/index.d.ts:34 |

---

---
url: 'https://gramio.dev/api/keyboards/interfaces/KeyboardHelperWrap.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / KeyboardHelperWrap

# Interface: KeyboardHelperWrap\<T>

Defined in: keyboards/index.d.ts:25

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `fn` | [`ButtonsIterator`](../type-aliases/ButtonsIterator.md)<`T`> | keyboards/index.d.ts:27 |
|  `type` | `"wrap"` | keyboards/index.d.ts:26 |

---

---
url: 'https://gramio.dev/api/i18n/interfaces/LanguageMap.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / LanguageMap

# Interface: LanguageMap

Defined in: i18n/index.d.ts:8

## Indexable

\[`key`: `string`]: `LanguageMap` | [`LocaleItem`](../type-aliases/LocaleItem.md)<`any`\[]>

---

---
url: 'https://gramio.dev/api/gramio/interfaces/LeaveChatParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / LeaveChatParams

# Interface: LeaveChatParams

Defined in: @gramio/types/out/params.d.ts:2201

Params object for [leaveChat](APIMethods.md#leavechat) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup or channel (in the format `@channelusername`). Channel direct messages chats aren't supported; leave the corresponding channel instead. | @gramio/types/out/params.d.ts:2205 |

---

---
url: 'https://gramio.dev/api/composer/interfaces/MacroHooks.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / MacroHooks

# Interface: MacroHooks\<TDerive>

Defined in: composer/index.d.ts:49

What a macro can return when activated

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `TDerive` *extends* `object` | `object` |

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `derive?` | (`ctx`) => `void` | `TDerive` | `Promise`<`void` | `TDerive`> | Context enrichment — return type gets merged into the handler's context. Return `void` / `undefined` to stop the middleware chain (acts as a guard). | composer/index.d.ts:56 |
|  `preHandler?` | [`Middleware`](../type-aliases/Middleware.md)<`any`> | [`Middleware`](../type-aliases/Middleware.md)<`any`>\[] | Middleware to run before the main handler | composer/index.d.ts:51 |

---

---
url: 'https://gramio.dev/api/composer/interfaces/MiddlewareInfo.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / MiddlewareInfo

# Interface: MiddlewareInfo

Defined in: composer/index.d.ts:105

Read-only projection of a middleware entry for inspect()/trace()

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `index` | `number` | composer/index.d.ts:106 |
|  `name?` | `string` | composer/index.d.ts:108 |
|  `plugin?` | `string` | composer/index.d.ts:110 |
|  `scope` | [`Scope`](../type-aliases/Scope.md) | composer/index.d.ts:109 |
|  `type` | [`MiddlewareType`](../type-aliases/MiddlewareType.md) | composer/index.d.ts:107 |

---

---
url: 'https://gramio.dev/api/scenes/interfaces/ParentSceneFrame.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / ParentSceneFrame

# Interface: ParentSceneFrame

Defined in: scenes/index.d.ts:148

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `name` | `string` | scenes/index.d.ts:149 |
|  `params` | `unknown` | scenes/index.d.ts:150 |
|  `parentStack?` | `ParentSceneFrame`\[] | scenes/index.d.ts:154 |
|  `previousStepId` | `number` | scenes/index.d.ts:153 |
|  `state` | `unknown` | scenes/index.d.ts:151 |
|  `stepId` | `number` | scenes/index.d.ts:152 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/PinChatMessageParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / PinChatMessageParams

# Interface: PinChatMessageParams

Defined in: @gramio/types/out/params.d.ts:2151

Params object for [pinChatMessage](APIMethods.md#pinchatmessage) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be pinned | @gramio/types/out/params.d.ts:2155 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2159 |
|  `disable_notification?` | `boolean` | Pass *True* if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats. | @gramio/types/out/params.d.ts:2167 |
|  `message_id` | `number` | Identifier of a message to pin | @gramio/types/out/params.d.ts:2163 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/PollingStartOptions.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / PollingStartOptions

# Interface: PollingStartOptions

Defined in: gramio/index.d.ts:829

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `deleteWebhookOnConflict?` | `boolean` | gramio/index.d.ts:831 |
|  `dropPendingUpdates?` | `boolean` | gramio/index.d.ts:830 |

---

---
url: 'https://gramio.dev/api/scenes/interfaces/PossibleInUnknownScene.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / PossibleInUnknownScene

# Interface: PossibleInUnknownScene\<Params, State, Scene>

Defined in: scenes/index.d.ts:197

## Extends

* [`EnterExit`](EnterExit.md)

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Params` | - |
| `State` *extends* [`StateTypesDefault`](../type-aliases/StateTypesDefault.md) | - |
| `Scene` *extends* [`AnyScene`](../type-aliases/AnyScene.md) | `null` | `null` |

## Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
|  `current` | `Scene` *extends* [`AnyScene`](../type-aliases/AnyScene.md) ? [`InActiveSceneHandlerReturn`](InActiveSceneHandlerReturn.md)<`Scene`\[`"~"`]\[`"params"`], `Partial`<`Scene`\[`"~"`]\[`"state"`]>, `Record`<`string`, `unknown`>> : [`InUnknownScene`](InUnknownScene.md)<`Params`, `State`, `Scene`> | - | scenes/index.d.ts:198 |
|  `enter` | [`SceneEnterHandler`](../type-aliases/SceneEnterHandler.md) | [`EnterExit`](EnterExit.md).[`enter`](EnterExit.md#enter) | scenes/index.d.ts:174 |
|  `exit` | () => [`MaybePromise`](../../../../gramio/type-aliases/MaybePromise.md)<`boolean`> | [`EnterExit`](EnterExit.md).[`exit`](EnterExit.md#exit) | scenes/index.d.ts:175 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/PostStoryParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / PostStoryParams

# Interface: PostStoryParams

Defined in: @gramio/types/out/params.d.ts:3147

Params object for [postStory](APIMethods.md#poststory) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `active_period` | [`PostStoryActivePeriod`](../type-aliases/PostStoryActivePeriod.md) | Period after which the story is moved to the archive, in seconds; must be one of `6 * 3600`, `12 * 3600`, `86400`, or `2 * 86400` | @gramio/types/out/params.d.ts:3159 |
|  `areas?` | [`TelegramStoryArea`](TelegramStoryArea.md)\[] | A JSON-serialized list of clickable areas to be shown on the story | @gramio/types/out/params.d.ts:3175 |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:3151 |
|  `caption?` | `string` | { `toString`: `string`; } | Caption of the story, 0-2048 characters after entities parsing | @gramio/types/out/params.d.ts:3163 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:3171 |
|  `content` | [`TelegramInputStoryContent`](../type-aliases/TelegramInputStoryContent.md) | Content of the story | @gramio/types/out/params.d.ts:3155 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the story caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:3167 |
|  `post_to_chat_page?` | `boolean` | Pass *True* to keep the story accessible after it expires | @gramio/types/out/params.d.ts:3179 |
|  `protect_content?` | `boolean` | Pass *True* if the content of the story must be protected from forwarding and screenshotting | @gramio/types/out/params.d.ts:3183 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/PromoteChatMemberParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / PromoteChatMemberParams

# Interface: PromoteChatMemberParams

Defined in: @gramio/types/out/params.d.ts:1787

Params object for [promoteChatMember](APIMethods.md#promotechatmember) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `can_change_info?` | `boolean` | Pass *True* if the administrator can change chat title, photo and other settings | @gramio/types/out/params.d.ts:1823 |
|  `can_delete_messages?` | `boolean` | Pass *True* if the administrator can delete messages of other users | @gramio/types/out/params.d.ts:1807 |
|  `can_delete_stories?` | `boolean` | Pass *True* if the administrator can delete stories posted by other users | @gramio/types/out/params.d.ts:1839 |
|  `can_edit_messages?` | `boolean` | Pass *True* if the administrator can edit messages of other users and can pin messages; for channels only | @gramio/types/out/params.d.ts:1847 |
|  `can_edit_stories?` | `boolean` | Pass *True* if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive | @gramio/types/out/params.d.ts:1835 |
|  `can_invite_users?` | `boolean` | Pass *True* if the administrator can invite new users to the chat | @gramio/types/out/params.d.ts:1827 |
|  `can_manage_chat?` | `boolean` | Pass *True* if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. | @gramio/types/out/params.d.ts:1803 |
|  `can_manage_direct_messages?` | `boolean` | Pass *True* if the administrator can manage direct messages within the channel and decline suggested posts; for channels only | @gramio/types/out/params.d.ts:1859 |
|  `can_manage_tags?` | `boolean` | Pass *True* if the administrator can edit the tags of regular members; for groups and supergroups only | @gramio/types/out/params.d.ts:1863 |
|  `can_manage_topics?` | `boolean` | Pass *True* if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | @gramio/types/out/params.d.ts:1855 |
|  `can_manage_video_chats?` | `boolean` | Pass *True* if the administrator can manage video chats | @gramio/types/out/params.d.ts:1811 |
|  `can_pin_messages?` | `boolean` | Pass *True* if the administrator can pin messages; for supergroups only | @gramio/types/out/params.d.ts:1851 |
|  `can_post_messages?` | `boolean` | Pass *True* if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | @gramio/types/out/params.d.ts:1843 |
|  `can_post_stories?` | `boolean` | Pass *True* if the administrator can post stories to the chat | @gramio/types/out/params.d.ts:1831 |
|  `can_promote_members?` | `boolean` | Pass *True* if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him) | @gramio/types/out/params.d.ts:1819 |
|  `can_restrict_members?` | `boolean` | Pass *True* if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to *True* for promotions of channel administrators | @gramio/types/out/params.d.ts:1815 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1791 |
|  `is_anonymous?` | `boolean` | Pass *True* if the administrator's presence in the chat is hidden | @gramio/types/out/params.d.ts:1799 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:1795 |

---

---
url: 'https://gramio.dev/api/prompt/interfaces/PromptFunction.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / PromptFunction

# Interface: PromptFunction()\<GlobalData>

Defined in: prompt/index.d.ts:101

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `GlobalData` | `never` |

## Call Signature

> **PromptFunction**<`Data`>(`text`, `params?`): `Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"`, `Data`>>

Defined in: prompt/index.d.ts:103

Send message and wait answer

### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Data` | `GlobalData` |

### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | [`Stringable`](../type-aliases/Stringable.md) |
| `params?` | [`PromptFunctionParams`](PromptFunctionParams.md)<`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"`, `Data`> |

### Returns

`Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"`, `Data`>>

## Call Signature

> **PromptFunction**<`Event`, `Data`>(`event`, `text`, `params?`): `Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`Event`, `Data`>>

Defined in: prompt/index.d.ts:105

Send message and wait answer ignoring events not listed

### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Event` *extends* `"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"` | - |
| `Data` | `GlobalData` |

### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | [`MaybeArray`](../type-aliases/MaybeArray.md)<`Event`> |
| `text` | [`Stringable`](../type-aliases/Stringable.md) |
| `params?` | [`PromptFunctionParams`](PromptFunctionParams.md)<`Event`, `Data`> |

### Returns

`Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`Event`, `Data`>>

---

---
url: 'https://gramio.dev/api/prompt/interfaces/PromptFunctionParams.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / PromptFunctionParams

# Interface: PromptFunctionParams\<Event, Data, ActionReturn>

Defined in: prompt/index.d.ts:95

Make some keys optional

## Extends

* [`Optional`](../../../contexts/dist/type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"chat_id"` | `"text"`>

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Event` *extends* [`EventsUnion`](../type-aliases/EventsUnion.md) | - |
| `Data` | - |
| `ActionReturn` | `never` |

## Properties

| Property | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`allow_paid_broadcast`](../../../../gramio/interfaces/SendMessageParams.md#allow_paid_broadcast) | @gramio/types/out/params.d.ts:135 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`business_connection_id`](../../../../gramio/interfaces/SendMessageParams.md#business_connection_id) | @gramio/types/out/params.d.ts:95 |
|  `chat_id?` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`chat_id`](../../../../gramio/interfaces/SendMessageParams.md#chat_id) | @gramio/types/out/params.d.ts:99 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`direct_messages_topic_id`](../../../../gramio/interfaces/SendMessageParams.md#direct_messages_topic_id) | @gramio/types/out/params.d.ts:107 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`disable_notification`](../../../../gramio/interfaces/SendMessageParams.md#disable_notification) | @gramio/types/out/params.d.ts:127 |
|  `entities?` | [`TelegramMessageEntity`](../../../../gramio/interfaces/TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in message text, which can be specified instead of *parse\_mode* | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`entities`](../../../../gramio/interfaces/SendMessageParams.md#entities) | @gramio/types/out/params.d.ts:119 |
|  `link_preview_options?` | [`TelegramLinkPreviewOptions`](../../../../gramio/interfaces/TelegramLinkPreviewOptions.md) | Link preview generation options for the message | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`link_preview_options`](../../../../gramio/interfaces/SendMessageParams.md#link_preview_options) | @gramio/types/out/params.d.ts:123 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`message_effect_id`](../../../../gramio/interfaces/SendMessageParams.md#message_effect_id) | @gramio/types/out/params.d.ts:139 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`message_thread_id`](../../../../gramio/interfaces/SendMessageParams.md#message_thread_id) | @gramio/types/out/params.d.ts:103 |
|  `onValidateError?` | `string` & `object` | [`OnValidateErrorFunction`](../type-aliases/OnValidateErrorFunction.md)<`Event`, `Data`, `ActionReturn`> | - | - | prompt/index.d.ts:98 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the message text. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`parse_mode`](../../../../gramio/interfaces/SendMessageParams.md#parse_mode) | @gramio/types/out/params.d.ts:115 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`protect_content`](../../../../gramio/interfaces/SendMessageParams.md#protect_content) | @gramio/types/out/params.d.ts:131 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](../../../../gramio/interfaces/TelegramInlineKeyboardMarkup.md); } | [`TelegramReplyKeyboardMarkup`](../../../../gramio/interfaces/TelegramReplyKeyboardMarkup.md) | { `toJSON`: [`TelegramReplyKeyboardMarkup`](../../../../gramio/interfaces/TelegramReplyKeyboardMarkup.md); } | [`TelegramReplyKeyboardRemove`](../../../../gramio/interfaces/TelegramReplyKeyboardRemove.md) | { `toJSON`: [`TelegramReplyKeyboardRemove`](../../../../gramio/interfaces/TelegramReplyKeyboardRemove.md); } | [`TelegramForceReply`](../../../../gramio/interfaces/TelegramForceReply.md) | { `toJSON`: [`TelegramForceReply`](../../../../gramio/interfaces/TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`reply_markup`](../../../../gramio/interfaces/SendMessageParams.md#reply_markup) | @gramio/types/out/params.d.ts:151 |
|  `reply_parameters?` | [`TelegramReplyParameters`](../../../../gramio/interfaces/TelegramReplyParameters.md) | Description of the message to reply to | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`reply_parameters`](../../../../gramio/interfaces/SendMessageParams.md#reply_parameters) | @gramio/types/out/params.d.ts:147 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](../../../../gramio/interfaces/TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`suggested_post_parameters`](../../../../gramio/interfaces/SendMessageParams.md#suggested_post_parameters) | @gramio/types/out/params.d.ts:143 |
|  `text?` | `string` | { `toString`: `string`; } | Text of the message to be sent, 1-4096 characters after entities parsing | [`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md).[`text`](../../../../gramio/interfaces/SendMessageParams.md#text) | @gramio/types/out/params.d.ts:111 |
|  `timeout?` | `number` | - | - | prompt/index.d.ts:99 |
|  `transform?` | [`TransformFunction`](../type-aliases/TransformFunction.md)<`Event`, `Data`> | - | - | prompt/index.d.ts:97 |
|  `validate?` | [`ValidateFunction`](../type-aliases/ValidateFunction.md)<`Event`> | - | - | prompt/index.d.ts:96 |

---

---
url: 'https://gramio.dev/api/prompt/interfaces/PromptOptions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / PromptOptions

# Interface: PromptOptions\<GlobalData>

Defined in: prompt/index.d.ts:12

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `GlobalData` | `never` |

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `defaults?` | [`PromptFunctionParams`](PromptFunctionParams.md)<`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"`, `GlobalData`> | - | prompt/index.d.ts:14 |
|  `map?` | [`PromptsType`](../type-aliases/PromptsType.md)<`GlobalData`> | - | prompt/index.d.ts:13 |
|  `timeoutStrategy?` | [`TimeoutStrategy`](../type-aliases/TimeoutStrategy.md) | Strategy for handling timeouts - "on-answer": Checks timeout expiration when user responds. If answer arrives after timeout, throws error - "on-timer": Uses setTimeout to reject automatically when timeout expires, regardless of user response timing **Default** `"on-answer"` | prompt/index.d.ts:22 |

---

---
url: 'https://gramio.dev/api/prompt/interfaces/PromptPluginTypes.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / PromptPluginTypes

# Interface: PromptPluginTypes\<GlobalData>

Defined in: prompt/index.d.ts:28

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `GlobalData` | `never` |

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `prompt` | [`PromptFunction`](PromptFunction.md)<`GlobalData`> | **Example** `import { Bot, format, bold } from "gramio"; import { prompt } from "@gramio/prompt"; const bot = new Bot(process.env.token!) .extend(prompt()) .command("start", async (context) => { const answer = await context.prompt( "message", format`What's your ${bold`name`}?` ); return context.send(`✨ Your name is ${answer.text}`); }) .onStart(console.log); bot.start();` | prompt/index.d.ts:50 |
|  `wait` | [`WaitFunction`](WaitFunction.md)<`GlobalData`> | Wait for the next event from the user **Example** `.command("start", async (context) => { const answer = await context.wait(); return context.send(`✨ Next message after /start command is ${answer.text}`); })` | prompt/index.d.ts:63 |
|  `waitWithAction` | [`WaitWithActionFunction`](WaitWithActionFunction.md)<`GlobalData`> | Wait for the next event from the user **Example** `.command("start", async (context) => { const [answer, message] = await context.waitWithAction("message", () => context.send("ok")); return context.send(`✨ Next message after /start command is ${answer.text}`); })` | prompt/index.d.ts:76 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/ReadBusinessMessageParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / ReadBusinessMessageParams

# Interface: ReadBusinessMessageParams

Defined in: @gramio/types/out/params.d.ts:2793

Params object for [readBusinessMessage](APIMethods.md#readbusinessmessage) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection on behalf of which to read the message | @gramio/types/out/params.d.ts:2797 |
|  `chat_id` | `number` | Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours. | @gramio/types/out/params.d.ts:2801 |
|  `message_id` | `number` | Unique identifier of the message to mark as read | @gramio/types/out/params.d.ts:2805 |

---

---
url: 'https://gramio.dev/api/storage-redis/ioredis/interfaces/RedisStorageOptions.md'
---
[GramIO API Reference](../../../../../index.md) / [storage-redis/ioredis](../index.md) / RedisStorageOptions

# Interface: RedisStorageOptions

Defined in: storage-redis/ioredis.d.ts:4

## Extends

* `RedisOptions`

## Properties

| Property | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `$ttl?` | `number` | time to live in seconds | - | storage-redis/ioredis.d.ts:6 |
|  `autoPipeliningIgnoredCommands?` | `string`\[] | **Default** `[]` | `RedisOptions.autoPipeliningIgnoredCommands` | ioredis/built/redis/RedisOptions.d.ts:156 |
|  `autoResendUnfulfilledCommands?` | `boolean` | Whether or not to resend unfulfilled commands on reconnect. Unfulfilled commands are most likely to be blocking commands such as `brpop` or `blpop`. **Default** `true` | `RedisOptions.autoResendUnfulfilledCommands` | ioredis/built/redis/RedisOptions.d.ts:89 |
|  `autoResubscribe?` | `boolean` | When the client reconnects, channels subscribed in the previous connection will be resubscribed automatically if `autoResubscribe` is `true`. **Default** `true` | `RedisOptions.autoResubscribe` | ioredis/built/redis/RedisOptions.d.ts:83 |
|  `blockingTimeout?` | `number` | Enables client-side timeout protection for blocking commands when set to a positive number. If `blockingTimeout` is undefined, `0`, or negative (e.g. `-1`), the protection is disabled and no client-side timers are installed for blocking commands. | `RedisOptions.blockingTimeout` | ioredis/built/redis/RedisOptions.d.ts:20 |
|  `blockingTimeoutGrace?` | `number` | Grace period (ms) added to blocking command timeouts. Only used when `blockingTimeout` is a positive number. Defaults to 100ms. | `RedisOptions.blockingTimeoutGrace` | ioredis/built/redis/RedisOptions.d.ts:25 |
|  `clientInfoTag?` | `string` | Tag to append to the library name in CLIENT SETINFO (ioredis(tag)). **Link** https://redis.io/docs/latest/commands/client-setinfo/ **Default** `undefined` | `RedisOptions.clientInfoTag` | ioredis/built/redis/RedisOptions.d.ts:62 |
|  `commandQueue?` | `boolean` | - | `RedisOptions.commandQueue` | ioredis/built/redis/RedisOptions.d.ts:158 |
|  `commandTimeout?` | `number` | If a command does not return a reply within a set number of milliseconds, a "Command timed out" error will be thrown. | `RedisOptions.commandTimeout` | ioredis/built/redis/RedisOptions.d.ts:13 |
|  `connectionName?` | `string` | Set the name of the connection to make it easier to identity the connection in client list. **Link** https://redis.io/commands/client-setname | `RedisOptions.connectionName` | ioredis/built/redis/RedisOptions.d.ts:50 |
|  `Connector?` | `ConnectorConstructor` | - | `RedisOptions.Connector` | ioredis/built/redis/RedisOptions.d.ts:7 |
|  `connectTimeout?` | `number` | How long the client will wait before killing a socket due to inactivity during initial connection. **Default** `10000` | `RedisOptions.connectTimeout` | ioredis/built/redis/RedisOptions.d.ts:126 |
|  `db?` | `number` | Database index to use. **Default** `0` | `RedisOptions.db` | ioredis/built/redis/RedisOptions.d.ts:77 |
|  `disableClientInfo?` | `boolean` | If true, skips setting library info via CLIENT SETINFO. **Link** https://redis.io/docs/latest/commands/client-setinfo/ **Default** `false` | `RedisOptions.disableClientInfo` | ioredis/built/redis/RedisOptions.d.ts:56 |
|  `disconnectTimeout?` | `number` | - | `RedisOptions.disconnectTimeout` | ioredis/built/connectors/SentinelConnector/index.d.ts:41 |
|  `enableAutoPipelining?` | `boolean` | **Default** `false` | `RedisOptions.enableAutoPipelining` | ioredis/built/redis/RedisOptions.d.ts:152 |
|  `enableOfflineQueue?` | `boolean` | By default, if the connection to Redis server has not been established, commands are added to a queue and are executed once the connection is "ready" (when `enableReadyCheck` is true, "ready" means the Redis server has loaded the database from disk, otherwise means the connection to the Redis server has been established). If this option is false, when execute the command when the connection isn't ready, an error will be returned. **Default** `true` | `RedisOptions.enableOfflineQueue` | ioredis/built/redis/RedisOptions.d.ts:169 |
|  `enableReadyCheck?` | `boolean` | The client will sent an INFO command to check whether the server is still loading data from the disk ( which happens when the server is just launched) when the connection is established, and only wait until the loading process is finished before emitting the `ready` event. **Default** `true` | `RedisOptions.enableReadyCheck` | ioredis/built/redis/RedisOptions.d.ts:177 |
|  `enableTLSForSentinelMode?` | `boolean` | - | `RedisOptions.enableTLSForSentinelMode` | ioredis/built/connectors/SentinelConnector/index.d.ts:43 |
|  `failoverDetector?` | `boolean` | - | `RedisOptions.failoverDetector` | ioredis/built/connectors/SentinelConnector/index.d.ts:51 |
|  `family?` | `number` | - | `RedisOptions.family` | @types/node/net.d.ts:53 |
|  `host?` | `string` | - | `RedisOptions.host` | @types/node/net.d.ts:49 |
|  `keepAlive?` | `number` | Enable/disable keep-alive functionality. **Link** https://nodejs.org/api/net.html#socketsetkeepaliveenable-initialdelay **Default** `0` | `RedisOptions.keepAlive` | ioredis/built/redis/RedisOptions.d.ts:38 |
|  `keyPrefix?` | `string` | - | `RedisOptions.keyPrefix` | ioredis/built/utils/Commander.d.ts:5 |
|  `lazyConnect?` | `boolean` | When a Redis instance is initialized, a connection to the server is immediately established. Set this to true will delay the connection to the server until the first command is sent or `redis.connect()` is called explicitly. When `redis.connect()` is called explicitly, a Promise is returned, which will be resolved when the connection is ready or rejected when it fails. The rejection should be handled by the user. **Default** `false` | `RedisOptions.lazyConnect` | ioredis/built/redis/RedisOptions.d.ts:186 |
|  `maxLoadingRetryTime?` | `number` | **Default** `10000` | `RedisOptions.maxLoadingRetryTime` | ioredis/built/redis/RedisOptions.d.ts:148 |
|  `maxRetriesPerRequest?` | `number` | The commands that don't get a reply due to the connection to the server is lost are put into a queue and will be resent on reconnect (if allowed by the `retryStrategy` option). This option is used to configure how many reconnection attempts should be allowed before the queue is flushed with a `MaxRetriesPerRequestError` error. Set this options to `null` instead of a number to let commands wait forever until the connection is alive again. **Default** `20` | `RedisOptions.maxRetriesPerRequest` | ioredis/built/redis/RedisOptions.d.ts:144 |
|  `monitor?` | `boolean` | This option is used internally when you call `redis.monitor()` to tell Redis to enter the monitor mode when the connection is established. **Default** `false` | `RedisOptions.monitor` | ioredis/built/redis/RedisOptions.d.ts:133 |
|  `name?` | `string` | Master group name of the Sentinel | `RedisOptions.name` | ioredis/built/connectors/SentinelConnector/index.d.ts:28 |
|  `natMap?` | `NatMap` | - | `RedisOptions.natMap` | ioredis/built/connectors/SentinelConnector/index.d.ts:45 |
|  `noDelay?` | `boolean` | Enable/disable the use of Nagle's algorithm. **Link** https://nodejs.org/api/net.html#socketsetnodelaynodelay **Default** `true` | `RedisOptions.noDelay` | ioredis/built/redis/RedisOptions.d.ts:44 |
|  `offlineQueue?` | `boolean` | - | `RedisOptions.offlineQueue` | ioredis/built/redis/RedisOptions.d.ts:157 |
|  `password?` | `string` | If set, client will send AUTH command with the value of this option when connected. | `RedisOptions.password` | ioredis/built/redis/RedisOptions.d.ts:71 |
|  `path?` | `string` | - | `RedisOptions.path` | @types/node/net.d.ts:69 |
|  `port?` | `number` | - | `RedisOptions.port` | @types/node/net.d.ts:48 |
|  `preferredSlaves?` | `PreferredSlaves` | - | `RedisOptions.preferredSlaves` | ioredis/built/connectors/SentinelConnector/index.d.ts:39 |
|  `readOnly?` | `boolean` | **Default** `false` | `RedisOptions.readOnly` | ioredis/built/redis/RedisOptions.d.ts:115 |
|  `reconnectOnError?` | `ReconnectOnError` | Whether or not to reconnect on certain Redis errors. This options by default is `null`, which means it should never reconnect on Redis errors. You can pass a function that accepts an Redis error, and returns: - `true` or `1` to trigger a reconnection. - `false` or `0` to not reconnect. - `2` to reconnect and resend the failed command (who triggered the error) after reconnection. **Example** `const redis = new Redis({ reconnectOnError(err) { const targetError = "READONLY"; if (err.message.includes(targetError)) { // Only reconnect when the error contains "READONLY" return true; // or `return 1;` } }, });` **Default** `null` | `RedisOptions.reconnectOnError` | ioredis/built/redis/RedisOptions.d.ts:111 |
|  `retryStrategy?` | (`times`) => `number` | `void` | - | `RedisOptions.retryStrategy` | ioredis/built/redis/RedisOptions.d.ts:8 |
|  `role?` | `"master"` | `"slave"` | **Default** `"master"` | `RedisOptions.role` | ioredis/built/connectors/SentinelConnector/index.d.ts:32 |
|  `scripts?` | `Record`<`string`, { `lua`: `string`; `numberOfKeys?`: `number`; `readOnly?`: `boolean`; }> | **Default** `undefined` | `RedisOptions.scripts` | ioredis/built/redis/RedisOptions.d.ts:190 |
|  `sentinelCommandTimeout?` | `number` | - | `RedisOptions.sentinelCommandTimeout` | ioredis/built/connectors/SentinelConnector/index.d.ts:42 |
|  `sentinelMaxConnections?` | `number` | **Default** `10` | `RedisOptions.sentinelMaxConnections` | ioredis/built/connectors/SentinelConnector/index.d.ts:50 |
|  `sentinelPassword?` | `string` | - | `RedisOptions.sentinelPassword` | ioredis/built/connectors/SentinelConnector/index.d.ts:35 |
|  `sentinelReconnectStrategy?` | (`retryAttempts`) => `number` | `void` | - | `RedisOptions.sentinelReconnectStrategy` | ioredis/built/connectors/SentinelConnector/index.d.ts:38 |
|  `sentinelRetryStrategy?` | (`retryAttempts`) => `number` | `void` | - | `RedisOptions.sentinelRetryStrategy` | ioredis/built/connectors/SentinelConnector/index.d.ts:37 |
|  `sentinels?` | `Partial`<`SentinelAddress`>\[] | - | `RedisOptions.sentinels` | ioredis/built/connectors/SentinelConnector/index.d.ts:36 |
|  `sentinelTLS?` | `ConnectionOptions` | - | `RedisOptions.sentinelTLS` | ioredis/built/connectors/SentinelConnector/index.d.ts:44 |
|  `sentinelUsername?` | `string` | - | `RedisOptions.sentinelUsername` | ioredis/built/connectors/SentinelConnector/index.d.ts:34 |
|  `showFriendlyErrorStack?` | `boolean` | - | `RedisOptions.showFriendlyErrorStack` | ioredis/built/utils/Commander.d.ts:6 |
|  `socketTimeout?` | `number` | If the socket does not receive data within a set number of milliseconds: 1. the socket is considered "dead" and will be destroyed 2. the client will reject any running commands (altought they might have been processed by the server) 3. the reconnect strategy will kick in (depending on the configuration) | `RedisOptions.socketTimeout` | ioredis/built/redis/RedisOptions.d.ts:32 |
|  `stringNumbers?` | `boolean` | When enabled, numbers returned by Redis will be converted to JavaScript strings instead of numbers. This is necessary if you want to handle big numbers (above `Number.MAX_SAFE_INTEGER` === 2^53). **Default** `false` | `RedisOptions.stringNumbers` | ioredis/built/redis/RedisOptions.d.ts:121 |
|  `tls?` | `ConnectionOptions` | - | `RedisOptions.tls` | ioredis/built/connectors/SentinelConnector/index.d.ts:33 |
|  `updateSentinels?` | `boolean` | - | `RedisOptions.updateSentinels` | ioredis/built/connectors/SentinelConnector/index.d.ts:46 |
|  `username?` | `string` | If set, client will send AUTH command with the value of this option as the first argument when connected. This is supported since Redis 6. | `RedisOptions.username` | ioredis/built/redis/RedisOptions.d.ts:67 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/RefundStarPaymentParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / RefundStarPaymentParams

# Interface: RefundStarPaymentParams

Defined in: @gramio/types/out/params.d.ts:4273

Params object for [refundStarPayment](APIMethods.md#refundstarpayment) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `telegram_payment_charge_id` | `string` | Telegram payment identifier | @gramio/types/out/params.d.ts:4281 |
|  `user_id` | `number` | Identifier of the user whose payment will be refunded | @gramio/types/out/params.d.ts:4277 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/RemoveBusinessAccountProfilePhotoParams.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / RemoveBusinessAccountProfilePhotoParams

# Interface: RemoveBusinessAccountProfilePhotoParams

Defined in: @gramio/types/out/params.d.ts:2889

Params object for [removeBusinessAccountProfilePhoto](APIMethods.md#removebusinessaccountprofilephoto) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:2893 |
|  `is_public?` | `boolean` | Pass *True* to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo. | @gramio/types/out/params.d.ts:2897 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/RemoveChatVerificationParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / RemoveChatVerificationParams

# Interface: RemoveChatVerificationParams

Defined in: @gramio/types/out/params.d.ts:2783

Params object for [removeChatVerification](APIMethods.md#removechatverification) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2787 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/RemoveUserVerificationParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / RemoveUserVerificationParams

# Interface: RemoveUserVerificationParams

Defined in: @gramio/types/out/params.d.ts:2773

Params object for [removeUserVerification](APIMethods.md#removeuserverification) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:2777 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/ReopenForumTopicParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / ReopenForumTopicParams

# Interface: ReopenForumTopicParams

Defined in: @gramio/types/out/params.d.ts:2345

Params object for [reopenForumTopic](APIMethods.md#reopenforumtopic) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2349 |
|  `message_thread_id` | `number` | Unique identifier for the target message thread of the forum topic | @gramio/types/out/params.d.ts:2353 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/ReopenGeneralForumTopicParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / ReopenGeneralForumTopicParams

# Interface: ReopenGeneralForumTopicParams

Defined in: @gramio/types/out/params.d.ts:2411

Params object for [reopenGeneralForumTopic](APIMethods.md#reopengeneralforumtopic) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2415 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/ReplaceStickerInSetParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / ReplaceStickerInSetParams

# Interface: ReplaceStickerInSetParams

Defined in: @gramio/types/out/params.d.ts:3793

Params object for [replaceStickerInSet](APIMethods.md#replacestickerinset) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `name` | `string` | Sticker set name | @gramio/types/out/params.d.ts:3801 |
|  `old_sticker` | `string` | File identifier of the replaced sticker | @gramio/types/out/params.d.ts:3805 |
|  `sticker` | [`TelegramInputSticker`](TelegramInputSticker.md) | A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged. | @gramio/types/out/params.d.ts:3809 |
|  `user_id` | `number` | User identifier of the sticker set owner | @gramio/types/out/params.d.ts:3797 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/RepostStoryParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / RepostStoryParams

# Interface: RepostStoryParams

Defined in: @gramio/types/out/params.d.ts:3191

Params object for [repostStory](APIMethods.md#repoststory) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `active_period` | [`RepostStoryActivePeriod`](../type-aliases/RepostStoryActivePeriod.md) | Period after which the story is moved to the archive, in seconds; must be one of `6 * 3600`, `12 * 3600`, `86400`, or `2 * 86400` | @gramio/types/out/params.d.ts:3207 |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:3195 |
|  `from_chat_id` | `number` | Unique identifier of the chat which posted the story that should be reposted | @gramio/types/out/params.d.ts:3199 |
|  `from_story_id` | `number` | Unique identifier of the story that should be reposted | @gramio/types/out/params.d.ts:3203 |
|  `post_to_chat_page?` | `boolean` | Pass *True* to keep the story accessible after it expires | @gramio/types/out/params.d.ts:3211 |
|  `protect_content?` | `boolean` | Pass *True* if the content of the story must be protected from forwarding and screenshotting | @gramio/types/out/params.d.ts:3215 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/RestrictChatMemberParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / RestrictChatMemberParams

# Interface: RestrictChatMemberParams

Defined in: @gramio/types/out/params.d.ts:1761

Params object for [restrictChatMember](APIMethods.md#restrictchatmember) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:1765 |
|  `permissions` | [`TelegramChatPermissions`](TelegramChatPermissions.md) | A JSON-serialized object for new user permissions | @gramio/types/out/params.d.ts:1773 |
|  `until_date?` | `number` | Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever | @gramio/types/out/params.d.ts:1781 |
|  `use_independent_chat_permissions?` | `boolean` | Pass *True* if chat permissions are set independently. Otherwise, the *can\_send\_other\_messages* and *can\_add\_web\_page\_previews* permissions will imply the *can\_send\_messages*, *can\_send\_audios*, *can\_send\_documents*, *can\_send\_photos*, *can\_send\_videos*, *can\_send\_video\_notes*, and *can\_send\_voice\_notes* permissions; the *can\_send\_polls* permission will imply the *can\_send\_messages* permission. | @gramio/types/out/params.d.ts:1777 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:1769 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/RevokeChatInviteLinkParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / RevokeChatInviteLinkParams

# Interface: RevokeChatInviteLinkParams

Defined in: @gramio/types/out/params.d.ts:2057

Params object for [revokeChatInviteLink](APIMethods.md#revokechatinvitelink) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier of the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2061 |
|  `invite_link` | `string` | The invite link to revoke | @gramio/types/out/params.d.ts:2065 |

---

---
url: 'https://gramio.dev/api/composer/interfaces/RouteBuilder.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / RouteBuilder

# Interface: RouteBuilder\<T, K>

Defined in: composer/index.d.ts:137

Route builder passed to the builder-callback overload of route()

## Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `object` |
| `K` *extends* `string` |

## Methods

### on()

> **on**(`key`, ...`middleware`): [`Composer`](../classes/Composer.md)<`T`, `T`, { }>

Defined in: composer/index.d.ts:139

Register a route. Returns a pre-typed Composer for chaining derive/use/guard etc.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `key` | `K` |
| ...`middleware` | [`Middleware`](../type-aliases/Middleware.md)<`T`>\[] |

#### Returns

[`Composer`](../classes/Composer.md)<`T`, `T`, { }>

***

### otherwise()

> **otherwise**(...`middleware`): `void`

Defined in: composer/index.d.ts:141

Fallback when router returns undefined or key has no handler

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`middleware` | [`Middleware`](../type-aliases/Middleware.md)<`T`>\[] |

#### Returns

`void`

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SavePreparedInlineMessageParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SavePreparedInlineMessageParams

# Interface: SavePreparedInlineMessageParams

Defined in: @gramio/types/out/params.d.ts:3963

Params object for [savePreparedInlineMessage](APIMethods.md#savepreparedinlinemessage) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_bot_chats?` | `boolean` | Pass *True* if the message can be sent to private chats with bots | @gramio/types/out/params.d.ts:3979 |
|  `allow_channel_chats?` | `boolean` | Pass *True* if the message can be sent to channel chats | @gramio/types/out/params.d.ts:3987 |
|  `allow_group_chats?` | `boolean` | Pass *True* if the message can be sent to group and supergroup chats | @gramio/types/out/params.d.ts:3983 |
|  `allow_user_chats?` | `boolean` | Pass *True* if the message can be sent to private chats with users | @gramio/types/out/params.d.ts:3975 |
|  `result` | [`TelegramInlineQueryResult`](../type-aliases/TelegramInlineQueryResult.md) | A JSON-serialized object describing the message to be sent | @gramio/types/out/params.d.ts:3971 |
|  `user_id` | `number` | Unique identifier of the target user that can use the prepared message | @gramio/types/out/params.d.ts:3967 |

---

---
url: 'https://gramio.dev/api/scenes/interfaces/ScenesOptions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / ScenesOptions

# Interface: ScenesOptions

Defined in: scenes/index.d.ts:145

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `storage?` | [`ScenesStorage`](../type-aliases/ScenesStorage.md) | scenes/index.d.ts:146 |

---

---
url: 'https://gramio.dev/api/scenes/interfaces/ScenesStorageData.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / ScenesStorageData

# Interface: ScenesStorageData\<Params, State>

Defined in: scenes/index.d.ts:156

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Params` | `any` |
| `State` | `any` |

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `firstTime` | `boolean` | scenes/index.d.ts:162 |
|  `name` | `string` | scenes/index.d.ts:157 |
|  `params` | `Params` | scenes/index.d.ts:158 |
|  `parentStack?` | [`ParentSceneFrame`](ParentSceneFrame.md)\[] | scenes/index.d.ts:163 |
|  `previousStepId` | `number` | scenes/index.d.ts:161 |
|  `state` | `State` | scenes/index.d.ts:159 |
|  `stepId` | `number` | scenes/index.d.ts:160 |

---

---
url: 'https://gramio.dev/api/scenes/interfaces/SceneUpdateState.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / SceneUpdateState

# Interface: SceneUpdateState

Defined in: scenes/index.d.ts:165

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `firstTime?` | `boolean` | - | scenes/index.d.ts:170 |
|  `step?` | `number` | **Default** `sceneData.stepId + 1` | scenes/index.d.ts:169 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendAnimationParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendAnimationParams

# Interface: SendAnimationParams

Defined in: @gramio/types/out/params.d.ts:729

Params object for [sendAnimation](APIMethods.md#sendanimation) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:797 |
|  `animation` | `string` | `Blob` | Animation to send. Pass a file\_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:749 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:733 |
|  `caption?` | `string` | { `toString`: `string`; } | Animation caption (may also be used when resending animation by *file\_id*), 0-1024 characters after entities parsing | @gramio/types/out/params.d.ts:769 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:777 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:737 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:745 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:789 |
|  `duration?` | `number` | Duration of sent animation in seconds | @gramio/types/out/params.d.ts:753 |
|  `has_spoiler?` | `boolean` | Pass *True* if the animation needs to be covered with a spoiler animation | @gramio/types/out/params.d.ts:785 |
|  `height?` | `number` | Animation height | @gramio/types/out/params.d.ts:761 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:801 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:741 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the animation caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:773 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:793 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:813 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:809 |
|  `show_caption_above_media?` | `boolean` | Pass *True*, if the caption must be shown above the message media | @gramio/types/out/params.d.ts:781 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:805 |
|  `thumbnail?` | `string` | `Blob` | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the thumbnail was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:765 |
|  `width?` | `number` | Animation width | @gramio/types/out/params.d.ts:757 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendAudioParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendAudioParams

# Interface: SendAudioParams

Defined in: @gramio/types/out/params.d.ts:447

Params object for [sendAudio](APIMethods.md#sendaudio) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:507 |
|  `audio` | `string` | `Blob` | Audio file to send. Pass a file\_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:467 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:451 |
|  `caption?` | `string` | { `toString`: `string`; } | Audio caption, 0-1024 characters after entities parsing | @gramio/types/out/params.d.ts:471 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:479 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:455 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:463 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:499 |
|  `duration?` | `number` | Duration of the audio in seconds | @gramio/types/out/params.d.ts:483 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:511 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:459 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the audio caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:475 |
|  `performer?` | `string` | Performer | @gramio/types/out/params.d.ts:487 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:503 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:523 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:519 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:515 |
|  `thumbnail?` | `string` | `Blob` | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the thumbnail was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:495 |
|  `title?` | `string` | Track name | @gramio/types/out/params.d.ts:491 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendChatActionParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendChatActionParams

# Interface: SendChatActionParams

Defined in: @gramio/types/out/params.d.ts:1613

Params object for [sendChatAction](APIMethods.md#sendchataction) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `action` | [`SendChatActionAction`](../type-aliases/SendChatActionAction.md) | Type of action to broadcast. Choose one, depending on what the user is about to receive: *typing* for [text messages](https://core.telegram.org/bots/api#sendmessage), *upload\_photo* for [photos](https://core.telegram.org/bots/api#sendphoto), *record\_video* or *upload\_video* for [videos](https://core.telegram.org/bots/api#sendvideo), *record\_voice* or *upload\_voice* for [voice notes](https://core.telegram.org/bots/api#sendvoice), *upload\_document* for [general files](https://core.telegram.org/bots/api#senddocument), *choose\_sticker* for [stickers](https://core.telegram.org/bots/api#sendsticker), *find\_location* for [location data](https://core.telegram.org/bots/api#sendlocation), *record\_video\_note* or *upload\_video\_note* for [video notes](https://core.telegram.org/bots/api#sendvideonote). | @gramio/types/out/params.d.ts:1629 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the action will be sent | @gramio/types/out/params.d.ts:1617 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`). Channel chats and channel direct messages chats aren't supported. | @gramio/types/out/params.d.ts:1621 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:1625 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendChecklistParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendChecklistParams

# Interface: SendChecklistParams

Defined in: @gramio/types/out/params.d.ts:1466

Params object for [sendChecklist](APIMethods.md#sendchecklist) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:1470 |
|  `chat_id` | `number` | Unique identifier for the target chat | @gramio/types/out/params.d.ts:1474 |
|  `checklist` | [`TelegramInputChecklist`](TelegramInputChecklist.md) | A JSON-serialized object for the checklist to send | @gramio/types/out/params.d.ts:1478 |
|  `disable_notification?` | `boolean` | Sends the message silently. Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:1482 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message | @gramio/types/out/params.d.ts:1490 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:1486 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) | @gramio/types/out/params.d.ts:1498 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | A JSON-serialized object for description of the message to reply to | @gramio/types/out/params.d.ts:1494 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendContactParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendContactParams

# Interface: SendContactParams

Defined in: @gramio/types/out/params.d.ts:1284

Params object for [sendContact](APIMethods.md#sendcontact) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:1328 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:1288 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1292 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:1300 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:1320 |
|  `first_name` | `string` | Contact's first name | @gramio/types/out/params.d.ts:1308 |
|  `last_name?` | `string` | Contact's last name | @gramio/types/out/params.d.ts:1312 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:1332 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:1296 |
|  `phone_number` | `string` | Contact's phone number | @gramio/types/out/params.d.ts:1304 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:1324 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:1344 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:1340 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:1336 |
|  `vcard?` | `string` | Additional data about the contact in the form of a [vCard](https://en.wikipedia.org/wiki/VCard), 0-2048 bytes | @gramio/types/out/params.d.ts:1316 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendDiceParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendDiceParams

# Interface: SendDiceParams

Defined in: @gramio/types/out/params.d.ts:1508

Params object for [sendDice](APIMethods.md#senddice) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:1540 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:1512 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1516 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:1524 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:1532 |
|  `emoji?` | [`SendDiceEmoji`](../type-aliases/SendDiceEmoji.md) | Emoji on which the dice throw animation is based. Currently, must be one of “![🎲](https://telegram.org/img/emoji/40/F09F8EB2.png)”, “![🎯](https://telegram.org/img/emoji/40/F09F8EAF.png)”, “![🏀](https://telegram.org/img/emoji/40/F09F8F80.png)”, “![⚽](https://telegram.org/img/emoji/40/E29ABD.png)”, “![🎳](https://telegram.org/img/emoji/40/F09F8EB3.png)”, or “![🎰](https://telegram.org/img/emoji/40/F09F8EB0.png)”. Dice can have values 1-6 for “![🎲](https://telegram.org/img/emoji/40/F09F8EB2.png)”, “![🎯](https://telegram.org/img/emoji/40/F09F8EAF.png)” and “![🎳](https://telegram.org/img/emoji/40/F09F8EB3.png)”, values 1-5 for “![🏀](https://telegram.org/img/emoji/40/F09F8F80.png)” and “![⚽](https://telegram.org/img/emoji/40/E29ABD.png)”, and values 1-64 for “![🎰](https://telegram.org/img/emoji/40/F09F8EB0.png)”. Defaults to “![🎲](https://telegram.org/img/emoji/40/F09F8EB2.png)” | @gramio/types/out/params.d.ts:1528 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:1544 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:1520 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding | @gramio/types/out/params.d.ts:1536 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:1556 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:1552 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:1548 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendDocumentParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendDocumentParams

# Interface: SendDocumentParams

Defined in: @gramio/types/out/params.d.ts:537

Params object for [sendDocument](APIMethods.md#senddocument) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:589 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:541 |
|  `caption?` | `string` | { `toString`: `string`; } | Document caption (may also be used when resending documents by *file\_id*), 0-1024 characters after entities parsing | @gramio/types/out/params.d.ts:565 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:573 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:545 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:553 |
|  `disable_content_type_detection?` | `boolean` | Disables automatic server-side content type detection for files uploaded using multipart/form-data | @gramio/types/out/params.d.ts:577 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:581 |
|  `document` | `string` | `Blob` | File to send. Pass a file\_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:557 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:593 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:549 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the document caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:569 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:585 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:605 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:601 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:597 |
|  `thumbnail?` | `string` | `Blob` | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the thumbnail was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:561 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendGameParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendGameParams

# Interface: SendGameParams

Defined in: @gramio/types/out/params.d.ts:4319

Params object for [sendGame](APIMethods.md#sendgame) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:4347 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:4323 |
|  `chat_id` | `number` | Unique identifier for the target chat. Games can't be sent to channel direct messages chats and channel chats. | @gramio/types/out/params.d.ts:4327 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:4339 |
|  `game_short_name` | `string` | Short name of the game, serves as the unique identifier for the game. Set up your games via [@BotFather](https://t.me/botfather). | @gramio/types/out/params.d.ts:4335 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:4351 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:4331 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:4343 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards). If empty, one 'Play game\_title' button will be shown. If not empty, the first button must launch the game. | @gramio/types/out/params.d.ts:4359 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:4355 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendGiftParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendGiftParams

# Interface: SendGiftParams

Defined in: @gramio/types/out/params.d.ts:2679

Params object for [sendGift](APIMethods.md#sendgift) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id?` | `string` | `number` | Required if *user\_id* is not specified. Unique identifier for the chat or username of the channel (in the format `@channelusername`) that will receive the gift. | @gramio/types/out/params.d.ts:2687 |
|  `gift_id` | `string` | Identifier of the gift; limited gifts can't be sent to channel chats | @gramio/types/out/params.d.ts:2691 |
|  `pay_for_upgrade?` | `boolean` | Pass *True* to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver | @gramio/types/out/params.d.ts:2695 |
|  `text?` | `string` | { `toString`: `string`; } | Text that will be shown along with the gift; 0-128 characters | @gramio/types/out/params.d.ts:2699 |
|  `text_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of *text\_parse\_mode*. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom\_emoji” are ignored. | @gramio/types/out/params.d.ts:2707 |
|  `text_parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the text. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom\_emoji” are ignored. | @gramio/types/out/params.d.ts:2703 |
|  `user_id?` | `number` | Required if *chat\_id* is not specified. Unique identifier of the target user who will receive the gift. | @gramio/types/out/params.d.ts:2683 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendInvoiceParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendInvoiceParams

# Interface: SendInvoiceParams

Defined in: @gramio/types/out/params.d.ts:3993

Params object for [sendInvoice](APIMethods.md#sendinvoice) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:4101 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:3997 |
|  `currency` | [`TelegramCurrencies`](../type-aliases/TelegramCurrencies.md) | Three-letter ISO 4217 currency code, see [more on currencies](https://core.telegram.org/bots/payments#supported-currencies). Pass “XTR” for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4025 |
|  `description` | `string` | Product description, 1-255 characters | @gramio/types/out/params.d.ts:4013 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:4005 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:4093 |
|  `is_flexible?` | `boolean` | Pass *True* if the final price depends on the shipping method. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4089 |
|  `max_tip_amount?` | `number` | The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of `US$ 1.45` pass `max_tip_amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4033 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:4105 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:4001 |
|  `need_email?` | `boolean` | Pass *True* if you require the user's email address to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4073 |
|  `need_name?` | `boolean` | Pass *True* if you require the user's full name to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4065 |
|  `need_phone_number?` | `boolean` | Pass *True* if you require the user's phone number to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4069 |
|  `need_shipping_address?` | `boolean` | Pass *True* if you require the user's shipping address to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4077 |
|  `payload` | `string` | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. | @gramio/types/out/params.d.ts:4017 |
|  `photo_height?` | `number` | Photo height | @gramio/types/out/params.d.ts:4061 |
|  `photo_size?` | `number` | Photo size in bytes | @gramio/types/out/params.d.ts:4053 |
|  `photo_url?` | `string` | URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. | @gramio/types/out/params.d.ts:4049 |
|  `photo_width?` | `number` | Photo width | @gramio/types/out/params.d.ts:4057 |
|  `prices` | [`TelegramLabeledPrice`](TelegramLabeledPrice.md)\[] | Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4029 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:4097 |
|  `provider_data?` | `string` | JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. | @gramio/types/out/params.d.ts:4045 |
|  `provider_token?` | `string` | Payment provider token, obtained via [@BotFather](https://t.me/botfather). Pass an empty string for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4021 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards). If empty, one 'Pay `total price`' button will be shown. If not empty, the first button must be a Pay button. | @gramio/types/out/params.d.ts:4117 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:4113 |
|  `send_email_to_provider?` | `boolean` | Pass *True* if the user's email address should be sent to the provider. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4085 |
|  `send_phone_number_to_provider?` | `boolean` | Pass *True* if the user's phone number should be sent to the provider. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/params.d.ts:4081 |
|  `start_parameter?` | `string` | Unique deep-linking parameter. If left empty, **forwarded copies** of the sent message will have a *Pay* button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a *URL* button with a deep link to the bot (instead of a *Pay* button), with the value used as the start parameter | @gramio/types/out/params.d.ts:4041 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:4109 |
|  `suggested_tip_amounts?` | `number`\[] | A JSON-serialized array of suggested amounts of tips in the *smallest units* of the currency (integer, **not** float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed *max\_tip\_amount*. | @gramio/types/out/params.d.ts:4037 |
|  `title` | `string` | Product name, 1-32 characters | @gramio/types/out/params.d.ts:4009 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendLocationParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendLocationParams

# Interface: SendLocationParams

Defined in: @gramio/types/out/params.d.ts:1112

Params object for [sendLocation](APIMethods.md#sendlocation) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:1164 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:1116 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1120 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:1128 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:1156 |
|  `heading?` | `number` | For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | @gramio/types/out/params.d.ts:1148 |
|  `horizontal_accuracy?` | `number` | The radius of uncertainty for the location, measured in meters; 0-1500 | @gramio/types/out/params.d.ts:1140 |
|  `latitude` | `number` | Latitude of the location | @gramio/types/out/params.d.ts:1132 |
|  `live_period?` | `number` | Period in seconds during which the location will be updated (see [Live Locations](https://telegram.org/blog/live-locations), should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. | @gramio/types/out/params.d.ts:1144 |
|  `longitude` | `number` | Longitude of the location | @gramio/types/out/params.d.ts:1136 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:1168 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:1124 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:1160 |
|  `proximity_alert_radius?` | `number` | For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | @gramio/types/out/params.d.ts:1152 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:1180 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:1176 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:1172 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendMediaGroupParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendMediaGroupParams

# Interface: SendMediaGroupParams

Defined in: @gramio/types/out/params.d.ts:1061

Params object for [sendMediaGroup](APIMethods.md#sendmediagroup) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:1098 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:1065 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1069 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat | @gramio/types/out/params.d.ts:1077 |
|  `disable_notification?` | `boolean` | Sends messages [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:1090 |
|  `media` | ([`TelegramInputMediaAudio`](TelegramInputMediaAudio.md) | [`TelegramInputMediaDocument`](TelegramInputMediaDocument.md) | [`TelegramInputMediaPhoto`](TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](TelegramInputMediaVideo.md))\[] | A JSON-serialized array describing messages to be sent, must include 2-10 items | @gramio/types/out/params.d.ts:1081 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:1102 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:1073 |
|  `protect_content?` | `boolean` | Protects the contents of the sent messages from forwarding and saving | @gramio/types/out/params.d.ts:1094 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:1106 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendMessageDraftParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendMessageDraftParams

# Interface: SendMessageDraftParams

Defined in: @gramio/types/out/params.d.ts:1570

Params object for [sendMessageDraft](APIMethods.md#sendmessagedraft) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `number` | Unique identifier for the target private chat | @gramio/types/out/params.d.ts:1574 |
|  `draft_id` | `number` | Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated | @gramio/types/out/params.d.ts:1582 |
|  `entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in message text, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:1594 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread | @gramio/types/out/params.d.ts:1578 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the message text. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:1590 |
|  `text` | `string` | { `toString`: `string`; } | Text of the message to be sent, 1-4096 characters after entities parsing | @gramio/types/out/params.d.ts:1586 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendMessageParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendMessageParams

# Interface: SendMessageParams

Defined in: @gramio/types/out/params.d.ts:91

Params object for [sendMessage](APIMethods.md#sendmessage) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:135 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:95 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:99 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:107 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:127 |
|  `entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in message text, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:119 |
|  `link_preview_options?` | [`TelegramLinkPreviewOptions`](TelegramLinkPreviewOptions.md) | Link preview generation options for the message | @gramio/types/out/params.d.ts:123 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:139 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:103 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the message text. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:115 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:131 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:151 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:147 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:143 |
|  `text` | `string` | { `toString`: `string`; } | Text of the message to be sent, 1-4096 characters after entities parsing | @gramio/types/out/params.d.ts:111 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendPaidMediaParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendPaidMediaParams

# Interface: SendPaidMediaParams

Defined in: @gramio/types/out/params.d.ts:979

Params object for [sendPaidMedia](APIMethods.md#sendpaidmedia) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:1035 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:983 |
|  `caption?` | `string` | { `toString`: `string`; } | Media caption, 0-1024 characters after entities parsing | @gramio/types/out/params.d.ts:1011 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:1019 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance. | @gramio/types/out/params.d.ts:987 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:995 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:1027 |
|  `media` | [`TelegramInputPaidMedia`](../type-aliases/TelegramInputPaidMedia.md)\[] | A JSON-serialized array describing the media to be sent; up to 10 items | @gramio/types/out/params.d.ts:1003 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:991 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the media caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:1015 |
|  `payload?` | `string` | Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes. | @gramio/types/out/params.d.ts:1007 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:1031 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:1047 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:1043 |
|  `show_caption_above_media?` | `boolean` | Pass *True*, if the caption must be shown above the message media | @gramio/types/out/params.d.ts:1023 |
|  `star_count` | `number` | The number of Telegram Stars that must be paid to buy access to the media; 1-25000 | @gramio/types/out/params.d.ts:999 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:1039 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendPhotoParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendPhotoParams

# Interface: SendPhotoParams

Defined in: @gramio/types/out/params.d.ts:365

Params object for [sendPhoto](APIMethods.md#sendphoto) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:417 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:369 |
|  `caption?` | `string` | { `toString`: `string`; } | Photo caption (may also be used when resending photos by *file\_id*), 0-1024 characters after entities parsing | @gramio/types/out/params.d.ts:389 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:397 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:373 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:381 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:409 |
|  `has_spoiler?` | `boolean` | Pass *True* if the photo needs to be covered with a spoiler animation | @gramio/types/out/params.d.ts:405 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:421 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:377 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the photo caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:393 |
|  `photo` | `string` | `Blob` | Photo to send. Pass a file\_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:385 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:413 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:433 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:429 |
|  `show_caption_above_media?` | `boolean` | Pass *True*, if the caption must be shown above the message media | @gramio/types/out/params.d.ts:401 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:425 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendPollParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendPollParams

# Interface: SendPollParams

Defined in: @gramio/types/out/params.d.ts:1360

Params object for [sendPoll](APIMethods.md#sendpoll) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:1440 |
|  `allows_multiple_answers?` | `boolean` | *True*, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to *False* | @gramio/types/out/params.d.ts:1400 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:1364 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`). Polls can't be sent to channel direct messages chats. | @gramio/types/out/params.d.ts:1368 |
|  `close_date?` | `number` | Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with *open\_period*. | @gramio/types/out/params.d.ts:1424 |
|  `correct_option_id?` | `number` | 0-based identifier of the correct answer option, required for polls in quiz mode | @gramio/types/out/params.d.ts:1404 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:1432 |
|  `explanation?` | `string` | { `toString`: `string`; } | Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing | @gramio/types/out/params.d.ts:1408 |
|  `explanation_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of *explanation\_parse\_mode* | @gramio/types/out/params.d.ts:1416 |
|  `explanation_parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the explanation. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:1412 |
|  `is_anonymous?` | `boolean` | *True*, if the poll needs to be anonymous, defaults to *True* | @gramio/types/out/params.d.ts:1392 |
|  `is_closed?` | `boolean` | Pass *True* if the poll needs to be immediately closed. This can be useful for poll preview. | @gramio/types/out/params.d.ts:1428 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:1444 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:1372 |
|  `open_period?` | `number` | Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with *close\_date*. | @gramio/types/out/params.d.ts:1420 |
|  `options` | [`TelegramInputPollOption`](TelegramInputPollOption.md)\[] | A JSON-serialized list of 2-12 answer options | @gramio/types/out/params.d.ts:1388 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:1436 |
|  `question` | `string` | { `toString`: `string`; } | Poll question, 1-300 characters | @gramio/types/out/params.d.ts:1376 |
|  `question_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of *question\_parse\_mode* | @gramio/types/out/params.d.ts:1384 |
|  `question_parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the question. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. Currently, only custom emoji entities are allowed | @gramio/types/out/params.d.ts:1380 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:1452 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:1448 |
|  `type?` | [`SendPollType`](../type-aliases/SendPollType.md) | Poll type, “quiz” or “regular”, defaults to “regular” | @gramio/types/out/params.d.ts:1396 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendStickerParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendStickerParams

# Interface: SendStickerParams

Defined in: @gramio/types/out/params.d.ts:3613

Params object for [sendSticker](APIMethods.md#sendsticker) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:3649 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:3617 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:3621 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:3629 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:3641 |
|  `emoji?` | `string` | Emoji associated with the sticker; only for just uploaded stickers | @gramio/types/out/params.d.ts:3637 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:3653 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:3625 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:3645 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:3665 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:3661 |
|  `sticker` | `string` | `Blob` | Sticker to send. Pass a file\_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files). Video and animated stickers can't be sent via an HTTP URL. | @gramio/types/out/params.d.ts:3633 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:3657 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendVenueParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendVenueParams

# Interface: SendVenueParams

Defined in: @gramio/types/out/params.d.ts:1194

Params object for [sendVenue](APIMethods.md#sendvenue) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `address` | `string` | Address of the venue | @gramio/types/out/params.d.ts:1226 |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:1254 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:1198 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1202 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:1210 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:1246 |
|  `foursquare_id?` | `string` | Foursquare identifier of the venue | @gramio/types/out/params.d.ts:1230 |
|  `foursquare_type?` | `string` | Foursquare type of the venue, if known. (For example, “arts\_entertainment/default”, “arts\_entertainment/aquarium” or “food/icecream”.) | @gramio/types/out/params.d.ts:1234 |
|  `google_place_id?` | `string` | Google Places identifier of the venue | @gramio/types/out/params.d.ts:1238 |
|  `google_place_type?` | `string` | Google Places type of the venue. (See [supported types](https://developers.google.com/places/web-service/supported_types).) | @gramio/types/out/params.d.ts:1242 |
|  `latitude` | `number` | Latitude of the venue | @gramio/types/out/params.d.ts:1214 |
|  `longitude` | `number` | Longitude of the venue | @gramio/types/out/params.d.ts:1218 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:1258 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:1206 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:1250 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:1270 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:1266 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:1262 |
|  `title` | `string` | Name of the venue | @gramio/types/out/params.d.ts:1222 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendVideoNoteParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendVideoNoteParams

# Interface: SendVideoNoteParams

Defined in: @gramio/types/out/params.d.ts:905

Params object for [sendVideoNote](APIMethods.md#sendvideonote) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:949 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:909 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:913 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:921 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:941 |
|  `duration?` | `number` | Duration of sent video in seconds | @gramio/types/out/params.d.ts:929 |
|  `length?` | `number` | Video width and height, i.e. diameter of the video message | @gramio/types/out/params.d.ts:933 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:953 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:917 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:945 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:965 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:961 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:957 |
|  `thumbnail?` | `string` | `Blob` | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the thumbnail was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:937 |
|  `video_note` | `string` | `Blob` | Video note to send. Pass a file\_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files). Sending video notes by a URL is currently unsupported | @gramio/types/out/params.d.ts:925 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendVideoParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendVideoParams

# Interface: SendVideoParams

Defined in: @gramio/types/out/params.d.ts:619

Params object for [sendVideo](APIMethods.md#sendvideo) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:699 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:623 |
|  `caption?` | `string` | { `toString`: `string`; } | Video caption (may also be used when resending videos by *file\_id*), 0-1024 characters after entities parsing | @gramio/types/out/params.d.ts:667 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:675 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:627 |
|  `cover?` | `string` | `Blob` | Cover for the video in the message. Pass a file\_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://\<file\_attach\_name>” to upload a new one using multipart/form-data under \<file\_attach\_name> name. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:659 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:635 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:691 |
|  `duration?` | `number` | Duration of sent video in seconds | @gramio/types/out/params.d.ts:643 |
|  `has_spoiler?` | `boolean` | Pass *True* if the video needs to be covered with a spoiler animation | @gramio/types/out/params.d.ts:683 |
|  `height?` | `number` | Video height | @gramio/types/out/params.d.ts:651 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:703 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:631 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the video caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:671 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:695 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:715 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:711 |
|  `show_caption_above_media?` | `boolean` | Pass *True*, if the caption must be shown above the message media | @gramio/types/out/params.d.ts:679 |
|  `start_timestamp?` | `number` | Start timestamp for the video in the message | @gramio/types/out/params.d.ts:663 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:707 |
|  `supports_streaming?` | `boolean` | Pass *True* if the uploaded video is suitable for streaming | @gramio/types/out/params.d.ts:687 |
|  `thumbnail?` | `string` | `Blob` | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the thumbnail was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:655 |
|  `video` | `string` | `Blob` | Video to send. Pass a file\_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:639 |
|  `width?` | `number` | Video width | @gramio/types/out/params.d.ts:647 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SendVoiceParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendVoiceParams

# Interface: SendVoiceParams

Defined in: @gramio/types/out/params.d.ts:827

Params object for [sendVoice](APIMethods.md#sendvoice) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_paid_broadcast?` | `boolean` | Pass *True* to allow up to 1000 messages per second, ignoring [broadcasting limits](https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:875 |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:831 |
|  `caption?` | `string` | { `toString`: `string`; } | Voice message caption, 0-1024 characters after entities parsing | @gramio/types/out/params.d.ts:851 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/params.d.ts:859 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:835 |
|  `direct_messages_topic_id?` | `number` | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:843 |
|  `disable_notification?` | `boolean` | Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:867 |
|  `duration?` | `number` | Duration of the voice message in seconds | @gramio/types/out/params.d.ts:863 |
|  `message_effect_id?` | `string` | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:879 |
|  `message_thread_id?` | `number` | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:839 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | Mode for parsing entities in the voice message caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/params.d.ts:855 |
|  `protect_content?` | `boolean` | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:871 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md) | [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md) | [`TelegramForceReply`](TelegramForceReply.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardMarkup`](TelegramReplyKeyboardMarkup.md); } | { `toJSON`: [`TelegramReplyKeyboardRemove`](TelegramReplyKeyboardRemove.md); } | { `toJSON`: [`TelegramForceReply`](TelegramForceReply.md); } | Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:891 |
|  `reply_parameters?` | [`TelegramReplyParameters`](TelegramReplyParameters.md) | Description of the message to reply to | @gramio/types/out/params.d.ts:887 |
|  `suggested_post_parameters?` | [`TelegramSuggestedPostParameters`](TelegramSuggestedPostParameters.md) | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:883 |
|  `voice` | `string` | `Blob` | Audio file to send. Pass a file\_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:847 |

---

---
url: 'https://gramio.dev/api/session/interfaces/SessionOptions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/session/dist](../index.md) / SessionOptions

# Interface: SessionOptions\<Data, Key, Lazy>

Defined in: session/index.d.ts:43

Options types from [session](../index.md#session) plugin

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Data` | `unknown` |
| `Key` *extends* `string` | `undefined` | `"session"` |
| `Lazy` *extends* `boolean` | `false` |

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `getSessionKey?` | (`context`) => [`MaybePromise`](../../../../gramio/type-aliases/MaybePromise.md)<`string`> | A function that allows you to specify which key will be used to identify the session in the storage **Default** (context) => `${context.senderId}` | session/index.d.ts:59 |
|  `initial?` | (`context`) => [`MaybePromise`](../../../../gramio/type-aliases/MaybePromise.md)<`Data`> | Specify which data will exist while there has not been an record in the repository yet To **type** a session data, you need to specify the type as the `ReturnType` of the initial function. `interface MySessionData { apple: number; some?: "maybe-empty"; } bot.extend( session({ key: "sessionKey", initial: (): MySessionData => ({ apple: 1 }), }) );` | session/index.d.ts:78 |
|  `key?` | `Key` | The key that will be added to the context **Default** `"session"` | session/index.d.ts:48 |
|  `lazy?` | `Lazy` | Enable lazy session loading. When true, session is only loaded from storage when accessed, reducing database reads for handlers that don't use sessions. **Default** `false` **Example** `// Lazy session - only loads if accessed bot.extend(session({ lazy: true, initial: () => ({ count: 0 }) })); bot.on("message", async (ctx) => { const session = await ctx.session; // Loads here session.count++; });` | session/index.d.ts:96 |
|  `storage?` | [`Storage`](../../../storage/dist/interfaces/Storage.md) | The [Storage](../../../storage/dist/interfaces/Storage.md) in which to store the session [Documentation](https://gramio.dev/storages/) | session/index.d.ts:54 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetBusinessAccountBioParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetBusinessAccountBioParams

# Interface: SetBusinessAccountBioParams

Defined in: @gramio/types/out/params.d.ts:2857

Params object for [setBusinessAccountBio](APIMethods.md#setbusinessaccountbio) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `bio?` | `string` | The new value of the bio for the business account; 0-140 characters | @gramio/types/out/params.d.ts:2865 |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:2861 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/SetBusinessAccountGiftSettingsParams.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetBusinessAccountGiftSettingsParams

# Interface: SetBusinessAccountGiftSettingsParams

Defined in: @gramio/types/out/params.d.ts:2903

Params object for [setBusinessAccountGiftSettings](APIMethods.md#setbusinessaccountgiftsettings) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `accepted_gift_types` | [`TelegramAcceptedGiftTypes`](TelegramAcceptedGiftTypes.md) | Types of gifts accepted by the business account | @gramio/types/out/params.d.ts:2915 |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:2907 |
|  `show_gift_button` | `boolean` | Pass *True*, if a button for sending a gift to the user or by the business account must always be shown in the input field | @gramio/types/out/params.d.ts:2911 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetBusinessAccountNameParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetBusinessAccountNameParams

# Interface: SetBusinessAccountNameParams

Defined in: @gramio/types/out/params.d.ts:2825

Params object for [setBusinessAccountName](APIMethods.md#setbusinessaccountname) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:2829 |
|  `first_name` | `string` | The new value of the first name for the business account; 1-64 characters | @gramio/types/out/params.d.ts:2833 |
|  `last_name?` | `string` | The new value of the last name for the business account; 0-64 characters | @gramio/types/out/params.d.ts:2837 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/SetBusinessAccountProfilePhotoParams.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetBusinessAccountProfilePhotoParams

# Interface: SetBusinessAccountProfilePhotoParams

Defined in: @gramio/types/out/params.d.ts:2871

Params object for [setBusinessAccountProfilePhoto](APIMethods.md#setbusinessaccountprofilephoto) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:2875 |
|  `is_public?` | `boolean` | Pass *True* to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo. | @gramio/types/out/params.d.ts:2883 |
|  `photo` | [`TelegramInputProfilePhoto`](../type-aliases/TelegramInputProfilePhoto.md) | The new profile photo to set | @gramio/types/out/params.d.ts:2879 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetBusinessAccountUsernameParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetBusinessAccountUsernameParams

# Interface: SetBusinessAccountUsernameParams

Defined in: @gramio/types/out/params.d.ts:2843

Params object for [setBusinessAccountUsername](APIMethods.md#setbusinessaccountusername) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:2847 |
|  `username?` | `string` | The new value of the username for the business account; 0-32 characters | @gramio/types/out/params.d.ts:2851 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/SetChatAdministratorCustomTitleParams.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetChatAdministratorCustomTitleParams

# Interface: SetChatAdministratorCustomTitleParams

Defined in: @gramio/types/out/params.d.ts:1869

Params object for [setChatAdministratorCustomTitle](APIMethods.md#setchatadministratorcustomtitle) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:1873 |
|  `custom_title` | `string` | New custom title for the administrator; 0-16 characters, emoji are not allowed | @gramio/types/out/params.d.ts:1881 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:1877 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetChatDescriptionParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetChatDescriptionParams

# Interface: SetChatDescriptionParams

Defined in: @gramio/types/out/params.d.ts:2137

Params object for [setChatDescription](APIMethods.md#setchatdescription) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2141 |
|  `description?` | `string` | New chat description, 0-255 characters | @gramio/types/out/params.d.ts:2145 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetChatMemberTagParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetChatMemberTagParams

# Interface: SetChatMemberTagParams

Defined in: @gramio/types/out/params.d.ts:1887

Params object for [setChatMemberTag](APIMethods.md#setchatmembertag) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:1891 |
|  `tag?` | `string` | New tag for the member; 0-16 characters, emoji are not allowed | @gramio/types/out/params.d.ts:1899 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:1895 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetChatMenuButtonParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetChatMenuButtonParams

# Interface: SetChatMenuButtonParams

Defined in: @gramio/types/out/params.d.ts:2631

Params object for [setChatMenuButton](APIMethods.md#setchatmenubutton) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id?` | `number` | Unique identifier for the target private chat. If not specified, default bot's menu button will be changed | @gramio/types/out/params.d.ts:2635 |
|  `menu_button?` | [`TelegramMenuButton`](../type-aliases/TelegramMenuButton.md) | A JSON-serialized object for the bot's new menu button. Defaults to [MenuButtonDefault](https://core.telegram.org/bots/api#menubuttondefault) | @gramio/types/out/params.d.ts:2639 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetChatPermissionsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetChatPermissionsParams

# Interface: SetChatPermissionsParams

Defined in: @gramio/types/out/params.d.ts:1933

Params object for [setChatPermissions](APIMethods.md#setchatpermissions) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:1937 |
|  `permissions` | [`TelegramChatPermissions`](TelegramChatPermissions.md) | A JSON-serialized object for new default chat permissions | @gramio/types/out/params.d.ts:1941 |
|  `use_independent_chat_permissions?` | `boolean` | Pass *True* if chat permissions are set independently. Otherwise, the *can\_send\_other\_messages* and *can\_add\_web\_page\_previews* permissions will imply the *can\_send\_messages*, *can\_send\_audios*, *can\_send\_documents*, *can\_send\_photos*, *can\_send\_videos*, *can\_send\_video\_notes*, and *can\_send\_voice\_notes* permissions; the *can\_send\_polls* permission will imply the *can\_send\_messages* permission. | @gramio/types/out/params.d.ts:1945 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetChatPhotoParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetChatPhotoParams

# Interface: SetChatPhotoParams

Defined in: @gramio/types/out/params.d.ts:2099

Params object for [setChatPhoto](APIMethods.md#setchatphoto) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2103 |
|  `photo` | `Blob` | New chat photo, uploaded using multipart/form-data | @gramio/types/out/params.d.ts:2107 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetChatStickerSetParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetChatStickerSetParams

# Interface: SetChatStickerSetParams

Defined in: @gramio/types/out/params.d.ts:2255

Params object for [setChatStickerSet](APIMethods.md#setchatstickerset) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2259 |
|  `sticker_set_name` | `string` | Name of the sticker set to be set as the group sticker set | @gramio/types/out/params.d.ts:2263 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetChatTitleParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetChatTitleParams

# Interface: SetChatTitleParams

Defined in: @gramio/types/out/params.d.ts:2123

Params object for [setChatTitle](APIMethods.md#setchattitle) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2127 |
|  `title` | `string` | New chat title, 1-128 characters | @gramio/types/out/params.d.ts:2131 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/SetCustomEmojiStickerSetThumbnailParams.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetCustomEmojiStickerSetThumbnailParams

# Interface: SetCustomEmojiStickerSetThumbnailParams

Defined in: @gramio/types/out/params.d.ts:3895

Params object for [setCustomEmojiStickerSetThumbnail](APIMethods.md#setcustomemojistickersetthumbnail) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `custom_emoji_id?` | `string` | Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail. | @gramio/types/out/params.d.ts:3903 |
|  `name` | `string` | Sticker set name | @gramio/types/out/params.d.ts:3899 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetGameScoreParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetGameScoreParams

# Interface: SetGameScoreParams

Defined in: @gramio/types/out/params.d.ts:4367

Params object for [setGameScore](APIMethods.md#setgamescore) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id?` | `number` | Required if *inline\_message\_id* is not specified. Unique identifier for the target chat | @gramio/types/out/params.d.ts:4387 |
|  `disable_edit_message?` | `boolean` | Pass *True* if the game message should not be automatically edited to include the current scoreboard | @gramio/types/out/params.d.ts:4383 |
|  `force?` | `boolean` | Pass *True* if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters | @gramio/types/out/params.d.ts:4379 |
|  `inline_message_id?` | `string` | Required if *chat\_id* and *message\_id* are not specified. Identifier of the inline message | @gramio/types/out/params.d.ts:4395 |
|  `message_id?` | `number` | Required if *inline\_message\_id* is not specified. Identifier of the sent message | @gramio/types/out/params.d.ts:4391 |
|  `score` | `number` | New score, must be non-negative | @gramio/types/out/params.d.ts:4375 |
|  `user_id` | `number` | User identifier | @gramio/types/out/params.d.ts:4371 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetMessageReactionParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetMessageReactionParams

# Interface: SetMessageReactionParams

Defined in: @gramio/types/out/params.d.ts:1635

Params object for [setMessageReaction](APIMethods.md#setmessagereaction) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1639 |
|  `is_big?` | `boolean` | Pass *True* to set the reaction with a big animation | @gramio/types/out/params.d.ts:1651 |
|  `message_id` | `number` | Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead. | @gramio/types/out/params.d.ts:1643 |
|  `reaction?` | [`TelegramReactionType`](../type-aliases/TelegramReactionType.md)\[] | A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots. | @gramio/types/out/params.d.ts:1647 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetMyCommandsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetMyCommandsParams

# Interface: SetMyCommandsParams

Defined in: @gramio/types/out/params.d.ts:2503

Params object for [setMyCommands](APIMethods.md#setmycommands) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `commands` | [`TelegramBotCommand`](TelegramBotCommand.md)\[] | A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified. | @gramio/types/out/params.d.ts:2507 |
|  `language_code?` | `string` | A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands | @gramio/types/out/params.d.ts:2515 |
|  `scope?` | [`TelegramBotCommandScope`](../type-aliases/TelegramBotCommandScope.md) | A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to [BotCommandScopeDefault](https://core.telegram.org/bots/api#botcommandscopedefault). | @gramio/types/out/params.d.ts:2511 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/SetMyDefaultAdministratorRightsParams.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetMyDefaultAdministratorRightsParams

# Interface: SetMyDefaultAdministratorRightsParams

Defined in: @gramio/types/out/params.d.ts:2655

Params object for [setMyDefaultAdministratorRights](APIMethods.md#setmydefaultadministratorrights) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `for_channels?` | `boolean` | Pass *True* to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed. | @gramio/types/out/params.d.ts:2663 |
|  `rights?` | [`TelegramChatAdministratorRights`](TelegramChatAdministratorRights.md) | A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared. | @gramio/types/out/params.d.ts:2659 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetMyDescriptionParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetMyDescriptionParams

# Interface: SetMyDescriptionParams

Defined in: @gramio/types/out/params.d.ts:2573

Params object for [setMyDescription](APIMethods.md#setmydescription) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `description?` | `string` | New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language. | @gramio/types/out/params.d.ts:2577 |
|  `language_code?` | `string` | A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description. | @gramio/types/out/params.d.ts:2581 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetMyNameParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetMyNameParams

# Interface: SetMyNameParams

Defined in: @gramio/types/out/params.d.ts:2549

Params object for [setMyName](APIMethods.md#setmyname) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `language_code?` | `string` | A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name. | @gramio/types/out/params.d.ts:2557 |
|  `name?` | `string` | New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language. | @gramio/types/out/params.d.ts:2553 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetMyProfilePhotoParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetMyProfilePhotoParams

# Interface: SetMyProfilePhotoParams

Defined in: @gramio/types/out/params.d.ts:2621

Params object for [setMyProfilePhoto](APIMethods.md#setmyprofilephoto) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `photo` | [`TelegramInputProfilePhoto`](../type-aliases/TelegramInputProfilePhoto.md) | The new profile photo to set | @gramio/types/out/params.d.ts:2625 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetMyShortDescriptionParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetMyShortDescriptionParams

# Interface: SetMyShortDescriptionParams

Defined in: @gramio/types/out/params.d.ts:2597

Params object for [setMyShortDescription](APIMethods.md#setmyshortdescription) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `language_code?` | `string` | A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description. | @gramio/types/out/params.d.ts:2605 |
|  `short_description?` | `string` | New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language. | @gramio/types/out/params.d.ts:2601 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetPassportDataErrorsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetPassportDataErrorsParams

# Interface: SetPassportDataErrorsParams

Defined in: @gramio/types/out/params.d.ts:4305

Params object for [setPassportDataErrors](APIMethods.md#setpassportdataerrors) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `errors` | [`TelegramPassportElementError`](../type-aliases/TelegramPassportElementError.md)\[] | A JSON-serialized array describing the errors | @gramio/types/out/params.d.ts:4313 |
|  `user_id` | `number` | User identifier | @gramio/types/out/params.d.ts:4309 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetStickerEmojiListParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetStickerEmojiListParams

# Interface: SetStickerEmojiListParams

Defined in: @gramio/types/out/params.d.ts:3815

Params object for [setStickerEmojiList](APIMethods.md#setstickeremojilist) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `emoji_list` | `string`\[] | A JSON-serialized list of 1-20 emoji associated with the sticker | @gramio/types/out/params.d.ts:3823 |
|  `sticker` | `string` | File identifier of the sticker | @gramio/types/out/params.d.ts:3819 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetStickerKeywordsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetStickerKeywordsParams

# Interface: SetStickerKeywordsParams

Defined in: @gramio/types/out/params.d.ts:3829

Params object for [setStickerKeywords](APIMethods.md#setstickerkeywords) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `keywords?` | `string`\[] | A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters | @gramio/types/out/params.d.ts:3837 |
|  `sticker` | `string` | File identifier of the sticker | @gramio/types/out/params.d.ts:3833 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetStickerMaskPositionParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetStickerMaskPositionParams

# Interface: SetStickerMaskPositionParams

Defined in: @gramio/types/out/params.d.ts:3843

Params object for [setStickerMaskPosition](APIMethods.md#setstickermaskposition) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `mask_position?` | [`TelegramMaskPosition`](TelegramMaskPosition.md) | A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position. | @gramio/types/out/params.d.ts:3851 |
|  `sticker` | `string` | File identifier of the sticker | @gramio/types/out/params.d.ts:3847 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetStickerPositionInSetParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetStickerPositionInSetParams

# Interface: SetStickerPositionInSetParams

Defined in: @gramio/types/out/params.d.ts:3769

Params object for [setStickerPositionInSet](APIMethods.md#setstickerpositioninset) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `position` | `number` | New sticker position in the set, zero-based | @gramio/types/out/params.d.ts:3777 |
|  `sticker` | `string` | File identifier of the sticker | @gramio/types/out/params.d.ts:3773 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetStickerSetThumbnailParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetStickerSetThumbnailParams

# Interface: SetStickerSetThumbnailParams

Defined in: @gramio/types/out/params.d.ts:3873

Params object for [setStickerSetThumbnail](APIMethods.md#setstickersetthumbnail) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `format` | [`SetStickerSetThumbnailFormat`](../type-aliases/SetStickerSetThumbnailFormat.md) | Format of the thumbnail, must be one of “static” for a **.WEBP** or **.PNG** image, “animated” for a **.TGS** animation, or “video” for a **.WEBM** video | @gramio/types/out/params.d.ts:3889 |
|  `name` | `string` | Sticker set name | @gramio/types/out/params.d.ts:3877 |
|  `thumbnail?` | `string` | `Blob` | A **.WEBP** or **.PNG** image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a **.TGS** animation with a thumbnail up to 32 kilobytes in size (see <https://core.telegram.org/stickers#animation-requirements> for animated sticker technical requirements), or a **.WEBM** video with the thumbnail up to 32 kilobytes in size; see <https://core.telegram.org/stickers#video-requirements> for video sticker technical requirements. Pass a *file\_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files). Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. | @gramio/types/out/params.d.ts:3885 |
|  `user_id` | `number` | User identifier of the sticker set owner | @gramio/types/out/params.d.ts:3881 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetStickerSetTitleParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetStickerSetTitleParams

# Interface: SetStickerSetTitleParams

Defined in: @gramio/types/out/params.d.ts:3857

Params object for [setStickerSetTitle](APIMethods.md#setstickersettitle) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `name` | `string` | Sticker set name | @gramio/types/out/params.d.ts:3861 |
|  `title` | `string` | Sticker set title, 1-64 characters | @gramio/types/out/params.d.ts:3865 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetUserEmojiStatusParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetUserEmojiStatusParams

# Interface: SetUserEmojiStatusParams

Defined in: @gramio/types/out/params.d.ts:1693

Params object for [setUserEmojiStatus](APIMethods.md#setuseremojistatus) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `emoji_status_custom_emoji_id?` | `string` | Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status. | @gramio/types/out/params.d.ts:1701 |
|  `emoji_status_expiration_date?` | `number` | Expiration date of the emoji status, if any | @gramio/types/out/params.d.ts:1705 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:1697 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/SetWebhookParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetWebhookParams

# Interface: SetWebhookParams

Defined in: @gramio/types/out/params.d.ts:46

Params object for [setWebhook](APIMethods.md#setwebhook) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allowed_updates?` | (`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"business_connection"` | `"business_message"` | `"edited_business_message"` | `"deleted_business_messages"` | `"message_reaction"` | `"message_reaction_count"` | `"inline_query"` | `"chosen_inline_result"` | `"callback_query"` | `"shipping_query"` | `"pre_checkout_query"` | `"purchased_paid_media"` | `"poll"` | `"poll_answer"` | `"my_chat_member"` | `"chat_member"` | `"chat_join_request"` | `"chat_boost"` | `"removed_chat_boost"`)\[] | A JSON-serialized list of the update types you want your bot to receive. For example, specify `["message", "edited_channel_post", "callback_query"]` to only receive updates of these types. See [Update](https://core.telegram.org/bots/api#update) for a complete list of available update types. Specify an empty list to receive all update types except *chat\_member*, *message\_reaction*, and *message\_reaction\_count* (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time. | @gramio/types/out/params.d.ts:67 |
|  `certificate?` | `Blob` | Upload your public key certificate so that the root certificate in use can be checked. See our [self-signed guide](https://core.telegram.org/bots/self-signed) for details. | @gramio/types/out/params.d.ts:54 |
|  `drop_pending_updates?` | `boolean` | Pass *True* to drop all pending updates | @gramio/types/out/params.d.ts:71 |
|  `ip_address?` | `string` | The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS | @gramio/types/out/params.d.ts:58 |
|  `max_connections?` | `number` | The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to *40*. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. | @gramio/types/out/params.d.ts:62 |
|  `secret_token?` | `string` | A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters `A-Z`, `a-z`, `0-9`, `_` and `-` are allowed. The header is useful to ensure that the request comes from a webhook set by you. | @gramio/types/out/params.d.ts:75 |
|  `url` | `string` | HTTPS URL to send updates to. Use an empty string to remove webhook integration | @gramio/types/out/params.d.ts:50 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/StopMessageLiveLocationParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / StopMessageLiveLocationParams

# Interface: StopMessageLiveLocationParams

Defined in: @gramio/types/out/params.d.ts:3441

Params object for [stopMessageLiveLocation](APIMethods.md#stopmessagelivelocation) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message to be edited was sent | @gramio/types/out/params.d.ts:3445 |
|  `chat_id?` | `string` | `number` | Required if *inline\_message\_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:3449 |
|  `inline_message_id?` | `string` | Required if *chat\_id* and *message\_id* are not specified. Identifier of the inline message | @gramio/types/out/params.d.ts:3457 |
|  `message_id?` | `number` | Required if *inline\_message\_id* is not specified. Identifier of the message with live location to stop | @gramio/types/out/params.d.ts:3453 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | A JSON-serialized object for a new [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards). | @gramio/types/out/params.d.ts:3461 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/StopPollParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / StopPollParams

# Interface: StopPollParams

Defined in: @gramio/types/out/params.d.ts:3525

Params object for [stopPoll](APIMethods.md#stoppoll) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message to be edited was sent | @gramio/types/out/params.d.ts:3529 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:3533 |
|  `message_id` | `number` | Identifier of the original message with the poll | @gramio/types/out/params.d.ts:3537 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | A JSON-serialized object for a new message [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards). | @gramio/types/out/params.d.ts:3541 |

---

---
url: 'https://gramio.dev/api/storage/interfaces/Storage.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/storage/dist](../index.md) / Storage

# Interface: Storage\<Data>

Defined in: storage/index.d.ts:49

Type of base storage which should implement all of storages

## Examples

```ts
import type { Storage } from "@gramio/storage";
import ThirdPartyStorage, { type ThirdPartyStorageOptions } from "some-library";

export interface MyOwnStorageOptions extends ThirdPartyStorageOptions {
    some?: number;
}

export function myOwnStorage(options: MyOwnStorageOptions = {}): Storage {
    const storage = new ThirdPartyStorage(options);

    return {
        async get(key) {
            const data = await storage.get(key);

            return data ? JSON.parse(data) : undefined;
        },
        async has(key) {
            return storage.has(key);
        },
        async set(key, value) {
            await storage.set(key, JSON.stringify(value));
        },
        async delete(key) {
            return storage.delete(key);
        },
    };
}
```

```ts
type T = Record<`Test${number}`, number> & Record<`Something${number}`, string>;
const storage = inMemoryStorage<T>();
const v1 = storage.get("Test1");   // v1: number | undefined
const v2 = storage.get("Something1");  // v2: string | undefined
```

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Data` *extends* `Record`<`string`, `any`> | `Record`<`string`, `any`> |

## Methods

### delete()

> **delete**<`K`>(`key`): `MaybePromise`<`boolean`>

Defined in: storage/index.d.ts:81

`delete` value from storage by the key.

#### Type Parameters

| Type Parameter |
| ------ |
| `K` *extends* `string` | `number` | `symbol` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `key` | `K` |

#### Returns

`MaybePromise`<`boolean`>

#### Example

```ts
await storage.delete("key");
```

***

### get()

> **get**<`K`>(`key`): `MaybePromise`<`Data`\[`K`]>

Defined in: storage/index.d.ts:57

`get` value from a storage.

#### Type Parameters

| Type Parameter |
| ------ |
| `K` *extends* `string` | `number` | `symbol` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `key` | `K` |

#### Returns

`MaybePromise`<`Data`\[`K`]>

#### Example

```ts
const data = await storage.get("key");
```

***

### has()

> **has**<`K`>(`key`): `MaybePromise`<`boolean`>

Defined in: storage/index.d.ts:73

`has` storage value by the key?

#### Type Parameters

| Type Parameter |
| ------ |
| `K` *extends* `string` | `number` | `symbol` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `key` | `K` |

#### Returns

`MaybePromise`<`boolean`>

#### Example

```ts
const isKeyExists = await storage.has("key");
```

***

### set()

> **set**<`K`>(`key`, `value`): `MaybePromise`<`void`>

Defined in: storage/index.d.ts:65

`set` value to a storage by the key.

#### Type Parameters

| Type Parameter |
| ------ |
| `K` *extends* `string` | `number` | `symbol` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `key` | `K` |
| `value` | `Data`\[`K`] |

#### Returns

`MaybePromise`<`void`>

#### Example

```ts
await storage.set("key", { value: true });
```

---

---
url: 'https://gramio.dev/api/gramio/namespaces/Hooks/interfaces/Store.md'
---
[GramIO API Reference](../../../../../index.md) / [gramio/dist](../../../index.md) / [Hooks](../index.md) / Store

# Interface: Store\<T>

Defined in: gramio/index.d.ts:798

Store hooks

## Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`ErrorDefinitions`](../../../type-aliases/ErrorDefinitions.md) |

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `onApiCall` | [`OnApiCall`](../type-aliases/OnApiCall.md)\<keyof [`APIMethods`](../../../interfaces/APIMethods.md)>\[] | gramio/index.d.ts:805 |
|  `onError` | [`OnError`](../type-aliases/OnError.md)<`T`, [`Context`](../../../../../contexts/classes/Context.md)<[`AnyBot`](../../../type-aliases/AnyBot.md)>>\[] | gramio/index.d.ts:802 |
|  `onResponse` | [`OnResponse`](../type-aliases/OnResponse.md)\<keyof [`APIMethods`](../../../interfaces/APIMethods.md)>\[] | gramio/index.d.ts:800 |
|  `onResponseError` | [`OnResponseError`](../type-aliases/OnResponseError.md)\<keyof [`APIMethods`](../../../interfaces/APIMethods.md)>\[] | gramio/index.d.ts:801 |
|  `onStart` | [`OnStart`](../type-aliases/OnStart.md)\[] | gramio/index.d.ts:803 |
|  `onStop` | [`OnStop`](../type-aliases/OnStop.md)\[] | gramio/index.d.ts:804 |
|  `preRequest` | [`PreRequest`](../type-aliases/PreRequest.md)\<keyof [`APIMethods`](../../../interfaces/APIMethods.md)>\[] | gramio/index.d.ts:799 |

---

---
url: 'https://gramio.dev/api/contexts/interfaces/StreamMessageOptions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / StreamMessageOptions

# Interface: StreamMessageOptions

Defined in: contexts/index.d.ts:281

Options for SendMixin.streamMessage

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `draftIdOffset?` | `number` | Offset added to draft IDs. Defaults to 256 \* updateId | contexts/index.d.ts:283 |
|  `draftParams?` | `Omit`<[`SendMessageDraftParams`](../../../../gramio/interfaces/SendMessageDraftParams.md), `"chat_id"` | `"draft_id"` | `"text"` | `"entities"`> | Extra params for sendMessageDraft calls (e.g. parse\_mode) | contexts/index.d.ts:285 |
|  `messageParams?` | [`Optional`](../type-aliases/Optional.md)<[`SendMessageParams`](../../../../gramio/interfaces/SendMessageParams.md), `"text"` | `"entities"` | `"chat_id"`> | Extra params for sendMessage calls (e.g. reply\_markup) | contexts/index.d.ts:287 |
|  `signal?` | `AbortSignal` | AbortSignal to cancel streaming | contexts/index.d.ts:289 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/Suppress.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / Suppress

# Interface: Suppress\<IsSuppressed>

Defined in: gramio/index.d.ts:618

Interface for add `suppress` param to params

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `IsSuppressed` *extends* `boolean` | `undefined` | `undefined` |

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `suppress?` | `IsSuppressed` | Pass `true` if you want to suppress throwing errors of this method. **But this does not undo getting into the `onResponseError` hook**. **Example** `const response = await bot.api.sendMessage({ 		suppress: true, 		chat_id: "@not_found", 		text: "Suppressed method" }); if(response instanceof TelegramError) console.error("sendMessage returns an error...") else console.log("Message has been sent successfully");` | gramio/index.d.ts:637 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramAcceptedGiftTypes.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramAcceptedGiftTypes

# Interface: TelegramAcceptedGiftTypes

Defined in: @gramio/types/out/objects.d.ts:5060

This object describes the types of gifts that can be gifted to a user or a chat.

[Documentation](https://core.telegram.org/bots/api/#acceptedgifttypes)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `gifts_from_channels` | `boolean` | *True*, if transfers of unique gifts from channels are accepted | @gramio/types/out/objects.d.ts:5080 |
|  `limited_gifts` | `boolean` | *True*, if limited regular gifts are accepted | @gramio/types/out/objects.d.ts:5068 |
|  `premium_subscription` | `boolean` | *True*, if a Telegram Premium subscription is accepted | @gramio/types/out/objects.d.ts:5076 |
|  `unique_gifts` | `boolean` | *True*, if unique gifts or gifts that can be upgraded to unique for free are accepted | @gramio/types/out/objects.d.ts:5072 |
|  `unlimited_gifts` | `boolean` | *True*, if unlimited regular gifts are accepted | @gramio/types/out/objects.d.ts:5064 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramAffiliateInfo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramAffiliateInfo

# Interface: TelegramAffiliateInfo

Defined in: @gramio/types/out/objects.d.ts:8062

Contains information about the affiliate that received a commission via this transaction.

[Documentation](https://core.telegram.org/bots/api/#affiliateinfo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `affiliate_chat?` | [`TelegramChat`](TelegramChat.md) | *Optional*. The chat that received an affiliate commission if it was received by a chat | @gramio/types/out/objects.d.ts:8070 |
|  `affiliate_user?` | [`TelegramUser`](TelegramUser.md) | *Optional*. The bot or the user that received an affiliate commission if it was received by a bot or a user | @gramio/types/out/objects.d.ts:8066 |
|  `amount` | `number` | Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds | @gramio/types/out/objects.d.ts:8078 |
|  `commission_per_mille` | `number` | The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users | @gramio/types/out/objects.d.ts:8074 |
|  `nanostar_amount?` | `number` | *Optional*. The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds | @gramio/types/out/objects.d.ts:8082 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramAnimation.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramAnimation

# Interface: TelegramAnimation

Defined in: @gramio/types/out/objects.d.ts:1353

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

[Documentation](https://core.telegram.org/bots/api/#animation)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `duration` | `number` | Duration of the video in seconds as defined by the sender | @gramio/types/out/objects.d.ts:1373 |
|  `file_id` | `string` | Identifier for this file, which can be used to download or reuse the file | @gramio/types/out/objects.d.ts:1357 |
|  `file_name?` | `string` | *Optional*. Original animation filename as defined by the sender | @gramio/types/out/objects.d.ts:1381 |
|  `file_size?` | `number` | *Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. | @gramio/types/out/objects.d.ts:1389 |
|  `file_unique_id` | `string` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:1361 |
|  `height` | `number` | Video height as defined by the sender | @gramio/types/out/objects.d.ts:1369 |
|  `mime_type?` | `string` | *Optional*. MIME type of the file as defined by the sender | @gramio/types/out/objects.d.ts:1385 |
|  `thumbnail?` | [`TelegramPhotoSize`](TelegramPhotoSize.md) | *Optional*. Animation thumbnail as defined by the sender | @gramio/types/out/objects.d.ts:1377 |
|  `width` | `number` | Video width as defined by the sender | @gramio/types/out/objects.d.ts:1365 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramAPIResponseError.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramAPIResponseError

# Interface: TelegramAPIResponseError

Defined in: @gramio/types/out/objects.d.ts:8915

In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'.

[Documentation](https://core.telegram.org/bots/api/#making-requests)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `description` | `string` | A human-readable description of the result | @gramio/types/out/objects.d.ts:8923 |
|  `error_code` | `number` | An Integer error code. Its contents are subject to change in the future. | @gramio/types/out/objects.d.ts:8927 |
|  `ok` | `false` | In case of an unsuccessful request, 'ok' equals false | @gramio/types/out/objects.d.ts:8919 |
|  `parameters?` | [`TelegramResponseParameters`](TelegramResponseParameters.md) | Optional field which can help to automatically handle the error | @gramio/types/out/objects.d.ts:8931 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramAPIResponseOk.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramAPIResponseOk

# Interface: TelegramAPIResponseOk\<Methods>

Defined in: @gramio/types/out/objects.d.ts:8897

If 'ok' equals True, the request was successful and the result of the query can be found in the 'result' field.

[Documentation](https://core.telegram.org/bots/api/#making-requests)

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Methods` *extends* keyof [`APIMethods`](APIMethods.md) | keyof [`APIMethods`](APIMethods.md) |

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `ok` | `true` | If 'ok' equals True, the request was successful | @gramio/types/out/objects.d.ts:8903 |
|  `result` | `Awaited`<`ReturnType`<[`APIMethods`](APIMethods.md)\[`Methods`]>> | The result of the query. The actual type depends on the called method. | @gramio/types/out/objects.d.ts:8907 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramAudio.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramAudio

# Interface: TelegramAudio

Defined in: @gramio/types/out/objects.d.ts:1397

This object represents an audio file to be treated as music by the Telegram clients.

[Documentation](https://core.telegram.org/bots/api/#audio)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `duration` | `number` | Duration of the audio in seconds as defined by the sender | @gramio/types/out/objects.d.ts:1409 |
|  `file_id` | `string` | Identifier for this file, which can be used to download or reuse the file | @gramio/types/out/objects.d.ts:1401 |
|  `file_name?` | `string` | *Optional*. Original filename as defined by the sender | @gramio/types/out/objects.d.ts:1421 |
|  `file_size?` | `number` | *Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. | @gramio/types/out/objects.d.ts:1429 |
|  `file_unique_id` | `string` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:1405 |
|  `mime_type?` | `string` | *Optional*. MIME type of the file as defined by the sender | @gramio/types/out/objects.d.ts:1425 |
|  `performer?` | `string` | *Optional*. Performer of the audio as defined by the sender or by audio tags | @gramio/types/out/objects.d.ts:1413 |
|  `thumbnail?` | [`TelegramPhotoSize`](TelegramPhotoSize.md) | *Optional*. Thumbnail of the album cover to which the music file belongs | @gramio/types/out/objects.d.ts:1433 |
|  `title?` | `string` | *Optional*. Title of the audio as defined by the sender or by audio tags | @gramio/types/out/objects.d.ts:1417 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramBackgroundFillFreeformGradient.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBackgroundFillFreeformGradient

# Interface: TelegramBackgroundFillFreeformGradient

Defined in: @gramio/types/out/objects.d.ts:2233

The background is a freeform gradient that rotates after every message in the chat.

[Documentation](https://core.telegram.org/bots/api/#backgroundfillfreeformgradient)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `colors` | `number`\[] | A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format | @gramio/types/out/objects.d.ts:2241 |
|  `type` | `"freeform_gradient"` | Type of the background fill, always “freeform\_gradient” | @gramio/types/out/objects.d.ts:2237 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBackgroundFillGradient.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBackgroundFillGradient

# Interface: TelegramBackgroundFillGradient

Defined in: @gramio/types/out/objects.d.ts:2209

The background is a gradient fill.

[Documentation](https://core.telegram.org/bots/api/#backgroundfillgradient)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `bottom_color` | `number` | Bottom color of the gradient in the RGB24 format | @gramio/types/out/objects.d.ts:2221 |
|  `rotation_angle` | `number` | Clockwise rotation angle of the background fill in degrees; 0-359 | @gramio/types/out/objects.d.ts:2225 |
|  `top_color` | `number` | Top color of the gradient in the RGB24 format | @gramio/types/out/objects.d.ts:2217 |
|  `type` | `"gradient"` | Type of the background fill, always “gradient” | @gramio/types/out/objects.d.ts:2213 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBackgroundFillSolid.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBackgroundFillSolid

# Interface: TelegramBackgroundFillSolid

Defined in: @gramio/types/out/objects.d.ts:2193

The background is filled using the selected color.

[Documentation](https://core.telegram.org/bots/api/#backgroundfillsolid)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `color` | `number` | The color of the background fill in the RGB24 format | @gramio/types/out/objects.d.ts:2201 |
|  `type` | `"solid"` | Type of the background fill, always “solid” | @gramio/types/out/objects.d.ts:2197 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBackgroundTypeChatTheme.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBackgroundTypeChatTheme

# Interface: TelegramBackgroundTypeChatTheme

Defined in: @gramio/types/out/objects.d.ts:2345

The background is taken directly from a built-in chat theme.

[Documentation](https://core.telegram.org/bots/api/#backgroundtypechattheme)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `theme_name` | `string` | Name of the chat theme, which is usually an emoji | @gramio/types/out/objects.d.ts:2353 |
|  `type` | `"chat_theme"` | Type of the background, always “chat\_theme” | @gramio/types/out/objects.d.ts:2349 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBackgroundTypeFill.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBackgroundTypeFill

# Interface: TelegramBackgroundTypeFill

Defined in: @gramio/types/out/objects.d.ts:2265

The background is automatically filled based on the selected colors.

[Documentation](https://core.telegram.org/bots/api/#backgroundtypefill)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `dark_theme_dimming` | `number` | Dimming of the background in dark themes, as a percentage; 0-100 | @gramio/types/out/objects.d.ts:2277 |
|  `fill` | [`TelegramBackgroundFill`](../type-aliases/TelegramBackgroundFill.md) | The background fill | @gramio/types/out/objects.d.ts:2273 |
|  `type` | `"fill"` | Type of the background, always “fill” | @gramio/types/out/objects.d.ts:2269 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBackgroundTypePattern.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBackgroundTypePattern

# Interface: TelegramBackgroundTypePattern

Defined in: @gramio/types/out/objects.d.ts:2313

The background is a .PNG or .TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.

[Documentation](https://core.telegram.org/bots/api/#backgroundtypepattern)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `document` | [`TelegramDocument`](TelegramDocument.md) | Document with the pattern | @gramio/types/out/objects.d.ts:2321 |
|  `fill` | [`TelegramBackgroundFill`](../type-aliases/TelegramBackgroundFill.md) | The background fill that is combined with the pattern | @gramio/types/out/objects.d.ts:2325 |
|  `intensity` | `number` | Intensity of the pattern when it is shown above the filled background; 0-100 | @gramio/types/out/objects.d.ts:2329 |
|  `is_inverted?` | `true` | *Optional*. *True*, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only | @gramio/types/out/objects.d.ts:2333 |
|  `is_moving?` | `true` | *Optional*. *True*, if the background moves slightly when the device is tilted | @gramio/types/out/objects.d.ts:2337 |
|  `type` | `"pattern"` | Type of the background, always “pattern” | @gramio/types/out/objects.d.ts:2317 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBackgroundTypeWallpaper.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBackgroundTypeWallpaper

# Interface: TelegramBackgroundTypeWallpaper

Defined in: @gramio/types/out/objects.d.ts:2285

The background is a wallpaper in the JPEG format.

[Documentation](https://core.telegram.org/bots/api/#backgroundtypewallpaper)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `dark_theme_dimming` | `number` | Dimming of the background in dark themes, as a percentage; 0-100 | @gramio/types/out/objects.d.ts:2297 |
|  `document` | [`TelegramDocument`](TelegramDocument.md) | Document with the wallpaper | @gramio/types/out/objects.d.ts:2293 |
|  `is_blurred?` | `true` | *Optional*. *True*, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12 | @gramio/types/out/objects.d.ts:2301 |
|  `is_moving?` | `true` | *Optional*. *True*, if the background moves slightly when the device is tilted | @gramio/types/out/objects.d.ts:2305 |
|  `type` | `"wallpaper"` | Type of the background, always “wallpaper” | @gramio/types/out/objects.d.ts:2289 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBirthdate.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBirthdate

# Interface: TelegramBirthdate

Defined in: @gramio/types/out/objects.d.ts:3991

Describes the birthdate of a user.

[Documentation](https://core.telegram.org/bots/api/#birthdate)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `day` | `number` | Day of the user's birth; 1-31 | @gramio/types/out/objects.d.ts:3995 |
|  `month` | `number` | Month of the user's birth; 1-12 | @gramio/types/out/objects.d.ts:3999 |
|  `year?` | `number` | *Optional*. Year of the user's birth | @gramio/types/out/objects.d.ts:4003 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBotCommand.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBotCommand

# Interface: TelegramBotCommand

Defined in: @gramio/types/out/objects.d.ts:5104

This object represents a bot command.

[Documentation](https://core.telegram.org/bots/api/#botcommand)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `command` | `string` | Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores. | @gramio/types/out/objects.d.ts:5108 |
|  `description` | `string` | Description of the command; 1-256 characters. | @gramio/types/out/objects.d.ts:5112 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramBotCommandScopeAllChatAdministrators.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBotCommandScopeAllChatAdministrators

# Interface: TelegramBotCommandScopeAllChatAdministrators

Defined in: @gramio/types/out/objects.d.ts:5178

Represents the [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all group and supergroup chat administrators.

[Documentation](https://core.telegram.org/bots/api/#botcommandscopeallchatadministrators)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"all_chat_administrators"` | Scope type, must be *all\_chat\_administrators* | @gramio/types/out/objects.d.ts:5182 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramBotCommandScopeAllGroupChats.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBotCommandScopeAllGroupChats

# Interface: TelegramBotCommandScopeAllGroupChats

Defined in: @gramio/types/out/objects.d.ts:5166

Represents the [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all group and supergroup chats.

[Documentation](https://core.telegram.org/bots/api/#botcommandscopeallgroupchats)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"all_group_chats"` | Scope type, must be *all\_group\_chats* | @gramio/types/out/objects.d.ts:5170 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramBotCommandScopeAllPrivateChats.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBotCommandScopeAllPrivateChats

# Interface: TelegramBotCommandScopeAllPrivateChats

Defined in: @gramio/types/out/objects.d.ts:5154

Represents the [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all private chats.

[Documentation](https://core.telegram.org/bots/api/#botcommandscopeallprivatechats)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"all_private_chats"` | Scope type, must be *all\_private\_chats* | @gramio/types/out/objects.d.ts:5158 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBotCommandScopeChat.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBotCommandScopeChat

# Interface: TelegramBotCommandScopeChat

Defined in: @gramio/types/out/objects.d.ts:5190

Represents the [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering a specific chat.

[Documentation](https://core.telegram.org/bots/api/#botcommandscopechat)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`). Channel direct messages chats and channel chats aren't supported. | @gramio/types/out/objects.d.ts:5198 |
|  `type` | `"chat"` | Scope type, must be *chat* | @gramio/types/out/objects.d.ts:5194 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramBotCommandScopeChatAdministrators.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBotCommandScopeChatAdministrators

# Interface: TelegramBotCommandScopeChatAdministrators

Defined in: @gramio/types/out/objects.d.ts:5206

Represents the [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all administrators of a specific group or supergroup chat.

[Documentation](https://core.telegram.org/bots/api/#botcommandscopechatadministrators)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`). Channel direct messages chats and channel chats aren't supported. | @gramio/types/out/objects.d.ts:5214 |
|  `type` | `"chat_administrators"` | Scope type, must be *chat\_administrators* | @gramio/types/out/objects.d.ts:5210 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBotCommandScopeChatMember.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBotCommandScopeChatMember

# Interface: TelegramBotCommandScopeChatMember

Defined in: @gramio/types/out/objects.d.ts:5222

Represents the [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering a specific member of a group or supergroup chat.

[Documentation](https://core.telegram.org/bots/api/#botcommandscopechatmember)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`). Channel direct messages chats and channel chats aren't supported. | @gramio/types/out/objects.d.ts:5230 |
|  `type` | `"chat_member"` | Scope type, must be *chat\_member* | @gramio/types/out/objects.d.ts:5226 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/objects.d.ts:5234 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBotCommandScopeDefault.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBotCommandScopeDefault

# Interface: TelegramBotCommandScopeDefault

Defined in: @gramio/types/out/objects.d.ts:5142

Represents the default [scope](https://core.telegram.org/bots/api#botcommandscope) of bot commands. Default commands are used if no commands with a [narrower scope](https://core.telegram.org/bots/api#determining-list-of-commands) are specified for the user.

[Documentation](https://core.telegram.org/bots/api/#botcommandscopedefault)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"default"` | Scope type, must be *default* | @gramio/types/out/objects.d.ts:5146 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBotDescription.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBotDescription

# Interface: TelegramBotDescription

Defined in: @gramio/types/out/objects.d.ts:5254

This object represents the bot's description.

[Documentation](https://core.telegram.org/bots/api/#botdescription)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `description` | `string` | The bot's description | @gramio/types/out/objects.d.ts:5258 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBotName.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBotName

# Interface: TelegramBotName

Defined in: @gramio/types/out/objects.d.ts:5242

This object represents the bot's name.

[Documentation](https://core.telegram.org/bots/api/#botname)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `name` | `string` | The bot's name | @gramio/types/out/objects.d.ts:5246 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBotShortDescription.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBotShortDescription

# Interface: TelegramBotShortDescription

Defined in: @gramio/types/out/objects.d.ts:5266

This object represents the bot's short description.

[Documentation](https://core.telegram.org/bots/api/#botshortdescription)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `short_description` | `string` | The bot's short description | @gramio/types/out/objects.d.ts:5270 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBusinessBotRights.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBusinessBotRights

# Interface: TelegramBusinessBotRights

Defined in: @gramio/types/out/objects.d.ts:5510

Represents the rights of a business bot.

[Documentation](https://core.telegram.org/bots/api/#businessbotrights)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `can_change_gift_settings?` | `true` | *Optional*. *True*, if the bot can change the privacy settings pertaining to gifts for the business account | @gramio/types/out/objects.d.ts:5546 |
|  `can_convert_gifts_to_stars?` | `true` | *Optional*. *True*, if the bot can convert regular gifts owned by the business account to Telegram Stars | @gramio/types/out/objects.d.ts:5554 |
|  `can_delete_all_messages?` | `true` | *Optional*. *True*, if the bot can delete all private messages in managed chats | @gramio/types/out/objects.d.ts:5526 |
|  `can_delete_sent_messages?` | `true` | *Optional*. *True*, if the bot can delete messages sent by the bot | @gramio/types/out/objects.d.ts:5522 |
|  `can_edit_bio?` | `true` | *Optional*. *True*, if the bot can edit the bio of the business account | @gramio/types/out/objects.d.ts:5534 |
|  `can_edit_name?` | `true` | *Optional*. *True*, if the bot can edit the first and last name of the business account | @gramio/types/out/objects.d.ts:5530 |
|  `can_edit_profile_photo?` | `true` | *Optional*. *True*, if the bot can edit the profile photo of the business account | @gramio/types/out/objects.d.ts:5538 |
|  `can_edit_username?` | `true` | *Optional*. *True*, if the bot can edit the username of the business account | @gramio/types/out/objects.d.ts:5542 |
|  `can_manage_stories?` | `true` | *Optional*. *True*, if the bot can post, edit and delete stories on behalf of the business account | @gramio/types/out/objects.d.ts:5566 |
|  `can_read_messages?` | `true` | *Optional*. *True*, if the bot can mark incoming private messages as read | @gramio/types/out/objects.d.ts:5518 |
|  `can_reply?` | `true` | *Optional*. *True*, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours | @gramio/types/out/objects.d.ts:5514 |
|  `can_transfer_and_upgrade_gifts?` | `true` | *Optional*. *True*, if the bot can transfer and upgrade gifts owned by the business account | @gramio/types/out/objects.d.ts:5558 |
|  `can_transfer_stars?` | `true` | *Optional*. *True*, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts | @gramio/types/out/objects.d.ts:5562 |
|  `can_view_gifts_and_stars?` | `true` | *Optional*. *True*, if the bot can view gifts and the amount of Telegram Stars owned by the business account | @gramio/types/out/objects.d.ts:5550 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBusinessConnection.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBusinessConnection

# Interface: TelegramBusinessConnection

Defined in: @gramio/types/out/objects.d.ts:5574

Describes the connection of the bot with a business account.

[Documentation](https://core.telegram.org/bots/api/#businessconnection)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `date` | `number` | Date the connection was established in Unix time | @gramio/types/out/objects.d.ts:5590 |
|  `id` | `string` | Unique identifier of the business connection | @gramio/types/out/objects.d.ts:5578 |
|  `is_enabled` | `boolean` | *True*, if the connection is active | @gramio/types/out/objects.d.ts:5598 |
|  `rights?` | [`TelegramBusinessBotRights`](TelegramBusinessBotRights.md) | *Optional*. Rights of the business bot | @gramio/types/out/objects.d.ts:5594 |
|  `user` | [`TelegramUser`](TelegramUser.md) | Business account user that created the business connection | @gramio/types/out/objects.d.ts:5582 |
|  `user_chat_id` | `number` | Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. | @gramio/types/out/objects.d.ts:5586 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBusinessIntro.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBusinessIntro

# Interface: TelegramBusinessIntro

Defined in: @gramio/types/out/objects.d.ts:4011

Contains information about the start page settings of a Telegram Business account.

[Documentation](https://core.telegram.org/bots/api/#businessintro)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `message?` | `string` | *Optional*. Message text of the business intro | @gramio/types/out/objects.d.ts:4019 |
|  `sticker?` | [`TelegramSticker`](TelegramSticker.md) | *Optional*. Sticker of the business intro | @gramio/types/out/objects.d.ts:4023 |
|  `title?` | `string` | *Optional*. Title text of the business intro | @gramio/types/out/objects.d.ts:4015 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBusinessLocation.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBusinessLocation

# Interface: TelegramBusinessLocation

Defined in: @gramio/types/out/objects.d.ts:4031

Contains information about the location of a Telegram Business account.

[Documentation](https://core.telegram.org/bots/api/#businesslocation)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `address` | `string` | Address of the business | @gramio/types/out/objects.d.ts:4035 |
|  `location?` | [`TelegramLocation`](TelegramLocation.md) | *Optional*. Location of the business | @gramio/types/out/objects.d.ts:4039 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBusinessMessagesDeleted.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBusinessMessagesDeleted

# Interface: TelegramBusinessMessagesDeleted

Defined in: @gramio/types/out/objects.d.ts:5606

This object is received when messages are deleted from a connected business account.

[Documentation](https://core.telegram.org/bots/api/#businessmessagesdeleted)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/objects.d.ts:5610 |
|  `chat` | [`TelegramChat`](TelegramChat.md) | Information about a chat in the business account. The bot may not have access to the chat or the corresponding user. | @gramio/types/out/objects.d.ts:5614 |
|  `message_ids` | `number`\[] | The list of identifiers of deleted messages in the chat of the business account | @gramio/types/out/objects.d.ts:5618 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramBusinessOpeningHours.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBusinessOpeningHours

# Interface: TelegramBusinessOpeningHours

Defined in: @gramio/types/out/objects.d.ts:4063

Describes the opening hours of a business.

[Documentation](https://core.telegram.org/bots/api/#businessopeninghours)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `opening_hours` | [`TelegramBusinessOpeningHoursInterval`](TelegramBusinessOpeningHoursInterval.md)\[] | List of time intervals describing business opening hours | @gramio/types/out/objects.d.ts:4071 |
|  `time_zone_name` | `string` | Unique name of the time zone for which the opening hours are defined | @gramio/types/out/objects.d.ts:4067 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramBusinessOpeningHoursInterval.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBusinessOpeningHoursInterval

# Interface: TelegramBusinessOpeningHoursInterval

Defined in: @gramio/types/out/objects.d.ts:4047

Describes an interval of time during which a business is open.

[Documentation](https://core.telegram.org/bots/api/#businessopeninghoursinterval)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `closing_minute` | `number` | The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 \* 24 \* 60 | @gramio/types/out/objects.d.ts:4055 |
|  `opening_minute` | `number` | The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 \* 24 \* 60 | @gramio/types/out/objects.d.ts:4051 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramCallbackGame.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramCallbackGame

# Interface: TelegramCallbackGame

Defined in: @gramio/types/out/objects.d.ts:8768

A placeholder, currently holds no information. Use [BotFather](https://t.me/botfather) to set up your game.

[Documentation](https://core.telegram.org/bots/api/#callbackgame)

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramCallbackQuery.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramCallbackQuery

# Interface: TelegramCallbackQuery

Defined in: @gramio/types/out/objects.d.ts:3359

This object represents an incoming callback query from a callback button in an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards). If the button that originated the query was attached to a message sent by the bot, the field *message* will be present. If the button was attached to a message sent via the bot (in [inline mode](https://core.telegram.org/bots/api#inline-mode)), the field *inline\_message\_id* will be present. Exactly one of the fields *data* or *game\_short\_name* will be present.

[Documentation](https://core.telegram.org/bots/api/#callbackquery)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_instance` | `string` | Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in [games](https://core.telegram.org/bots/api#games). | @gramio/types/out/objects.d.ts:3379 |
|  `data?` | `string` | *Optional*. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data. | @gramio/types/out/objects.d.ts:3383 |
|  `from` | [`TelegramUser`](TelegramUser.md) | Sender | @gramio/types/out/objects.d.ts:3367 |
|  `game_short_name?` | `string` | *Optional*. Short name of a [Game](https://core.telegram.org/bots/api#games) to be returned, serves as the unique identifier for the game | @gramio/types/out/objects.d.ts:3387 |
|  `id` | `string` | Unique identifier for this query | @gramio/types/out/objects.d.ts:3363 |
|  `inline_message_id?` | `string` | *Optional*. Identifier of the message sent via the bot in inline mode, that originated the query. | @gramio/types/out/objects.d.ts:3375 |
|  `message?` | [`TelegramMaybeInaccessibleMessage`](../type-aliases/TelegramMaybeInaccessibleMessage.md) | *Optional*. Message sent by the bot with the callback button that originated the query | @gramio/types/out/objects.d.ts:3371 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChat.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChat

# Interface: TelegramChat

Defined in: @gramio/types/out/objects.d.ts:243

This object represents a chat.

[Documentation](https://core.telegram.org/bots/api/#chat)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `first_name?` | `string` | *Optional*. First name of the other party in a private chat | @gramio/types/out/objects.d.ts:263 |
|  `id` | `number` | Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. | @gramio/types/out/objects.d.ts:247 |
|  `is_direct_messages?` | `true` | *Optional*. *True*, if the chat is the direct messages chat of a channel | @gramio/types/out/objects.d.ts:275 |
|  `is_forum?` | `true` | *Optional*. *True*, if the supergroup chat is a forum (has [topics](https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups) enabled) | @gramio/types/out/objects.d.ts:271 |
|  `last_name?` | `string` | *Optional*. Last name of the other party in a private chat | @gramio/types/out/objects.d.ts:267 |
|  `title?` | `string` | *Optional*. Title, for supergroups, channels and group chats | @gramio/types/out/objects.d.ts:255 |
|  `type` | [`TelegramChatType`](../type-aliases/TelegramChatType.md) | Type of the chat, can be either “private”, “group”, “supergroup” or “channel” | @gramio/types/out/objects.d.ts:251 |
|  `username?` | `string` | *Optional*. Username, for private chats, supergroups and channels if available | @gramio/types/out/objects.d.ts:259 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatAdministratorRights.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatAdministratorRights

# Interface: TelegramChatAdministratorRights

Defined in: @gramio/types/out/objects.d.ts:3491

Represents the rights of an administrator in a chat.

[Documentation](https://core.telegram.org/bots/api/#chatadministratorrights)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `can_change_info` | `boolean` | *True*, if the user is allowed to change the chat title, photo and other settings | @gramio/types/out/objects.d.ts:3519 |
|  `can_delete_messages` | `boolean` | *True*, if the administrator can delete messages of other users | @gramio/types/out/objects.d.ts:3503 |
|  `can_delete_stories` | `boolean` | *True*, if the administrator can delete stories posted by other users | @gramio/types/out/objects.d.ts:3535 |
|  `can_edit_messages?` | `boolean` | *Optional*. *True*, if the administrator can edit messages of other users and can pin messages; for channels only | @gramio/types/out/objects.d.ts:3543 |
|  `can_edit_stories` | `boolean` | *True*, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive | @gramio/types/out/objects.d.ts:3531 |
|  `can_invite_users` | `boolean` | *True*, if the user is allowed to invite new users to the chat | @gramio/types/out/objects.d.ts:3523 |
|  `can_manage_chat` | `boolean` | *True*, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. | @gramio/types/out/objects.d.ts:3499 |
|  `can_manage_direct_messages?` | `boolean` | *Optional*. *True*, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only | @gramio/types/out/objects.d.ts:3555 |
|  `can_manage_tags?` | `boolean` | *Optional*. *True*, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can\_pin\_messages. | @gramio/types/out/objects.d.ts:3559 |
|  `can_manage_topics?` | `boolean` | *Optional*. *True*, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | @gramio/types/out/objects.d.ts:3551 |
|  `can_manage_video_chats` | `boolean` | *True*, if the administrator can manage video chats | @gramio/types/out/objects.d.ts:3507 |
|  `can_pin_messages?` | `boolean` | *Optional*. *True*, if the user is allowed to pin messages; for groups and supergroups only | @gramio/types/out/objects.d.ts:3547 |
|  `can_post_messages?` | `boolean` | *Optional*. *True*, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | @gramio/types/out/objects.d.ts:3539 |
|  `can_post_stories` | `boolean` | *True*, if the administrator can post stories to the chat | @gramio/types/out/objects.d.ts:3527 |
|  `can_promote_members` | `boolean` | *True*, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user) | @gramio/types/out/objects.d.ts:3515 |
|  `can_restrict_members` | `boolean` | *True*, if the administrator can restrict, ban or unban chat members, or access supergroup statistics | @gramio/types/out/objects.d.ts:3511 |
|  `is_anonymous` | `boolean` | *True*, if the user's presence in the chat is hidden | @gramio/types/out/objects.d.ts:3495 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatBackground.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatBackground

# Interface: TelegramChatBackground

Defined in: @gramio/types/out/objects.d.ts:2361

This object represents a chat background.

[Documentation](https://core.telegram.org/bots/api/#chatbackground)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | [`TelegramBackgroundType`](../type-aliases/TelegramBackgroundType.md) | Type of the background | @gramio/types/out/objects.d.ts:2365 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatBoost.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatBoost

# Interface: TelegramChatBoost

Defined in: @gramio/types/out/objects.d.ts:5410

This object contains information about a chat boost.

[Documentation](https://core.telegram.org/bots/api/#chatboost)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `add_date` | `number` | Point in time (Unix timestamp) when the chat was boosted | @gramio/types/out/objects.d.ts:5418 |
|  `boost_id` | `string` | Unique identifier of the boost | @gramio/types/out/objects.d.ts:5414 |
|  `expiration_date` | `number` | Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged | @gramio/types/out/objects.d.ts:5422 |
|  `source` | [`TelegramChatBoostSource`](../type-aliases/TelegramChatBoostSource.md) | Source of the added boost | @gramio/types/out/objects.d.ts:5426 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatBoostAdded.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatBoostAdded

# Interface: TelegramChatBoostAdded

Defined in: @gramio/types/out/objects.d.ts:2167

This object represents a service message about a user boosting a chat.

[Documentation](https://core.telegram.org/bots/api/#chatboostadded)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `boost_count` | `number` | Number of boosts added by the user | @gramio/types/out/objects.d.ts:2171 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatBoostRemoved.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatBoostRemoved

# Interface: TelegramChatBoostRemoved

Defined in: @gramio/types/out/objects.d.ts:5450

This object represents a boost removed from a chat.

[Documentation](https://core.telegram.org/bots/api/#chatboostremoved)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `boost_id` | `string` | Unique identifier of the boost | @gramio/types/out/objects.d.ts:5458 |
|  `chat` | [`TelegramChat`](TelegramChat.md) | Chat which was boosted | @gramio/types/out/objects.d.ts:5454 |
|  `remove_date` | `number` | Point in time (Unix timestamp) when the boost was removed | @gramio/types/out/objects.d.ts:5462 |
|  `source` | [`TelegramChatBoostSource`](../type-aliases/TelegramChatBoostSource.md) | Source of the removed boost | @gramio/types/out/objects.d.ts:5466 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatBoostSourceGiftCode.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatBoostSourceGiftCode

# Interface: TelegramChatBoostSourceGiftCode

Defined in: @gramio/types/out/objects.d.ts:5366

The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.

[Documentation](https://core.telegram.org/bots/api/#chatboostsourcegiftcode)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `source` | `"gift_code"` | Source of the boost, always “gift\_code” | @gramio/types/out/objects.d.ts:5370 |
|  `user` | [`TelegramUser`](TelegramUser.md) | User for which the gift code was created | @gramio/types/out/objects.d.ts:5374 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatBoostSourceGiveaway.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatBoostSourceGiveaway

# Interface: TelegramChatBoostSourceGiveaway

Defined in: @gramio/types/out/objects.d.ts:5382

The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and *prize\_star\_count* / 500 times for one year for Telegram Star giveaways.

[Documentation](https://core.telegram.org/bots/api/#chatboostsourcegiveaway)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `giveaway_message_id` | `number` | Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet. | @gramio/types/out/objects.d.ts:5390 |
|  `is_unclaimed?` | `true` | *Optional*. *True*, if the giveaway was completed, but there was no user to win the prize | @gramio/types/out/objects.d.ts:5402 |
|  `prize_star_count?` | `number` | *Optional*. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | @gramio/types/out/objects.d.ts:5398 |
|  `source` | `"giveaway"` | Source of the boost, always “giveaway” | @gramio/types/out/objects.d.ts:5386 |
|  `user?` | [`TelegramUser`](TelegramUser.md) | *Optional*. User that won the prize in the giveaway if any; for Telegram Premium giveaways only | @gramio/types/out/objects.d.ts:5394 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatBoostSourcePremium.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatBoostSourcePremium

# Interface: TelegramChatBoostSourcePremium

Defined in: @gramio/types/out/objects.d.ts:5350

The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.

[Documentation](https://core.telegram.org/bots/api/#chatboostsourcepremium)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `source` | `"premium"` | Source of the boost, always “premium” | @gramio/types/out/objects.d.ts:5354 |
|  `user` | [`TelegramUser`](TelegramUser.md) | User that boosted the chat | @gramio/types/out/objects.d.ts:5358 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatBoostUpdated.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatBoostUpdated

# Interface: TelegramChatBoostUpdated

Defined in: @gramio/types/out/objects.d.ts:5434

This object represents a boost added to a chat or changed.

[Documentation](https://core.telegram.org/bots/api/#chatboostupdated)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `boost` | [`TelegramChatBoost`](TelegramChatBoost.md) | Information about the chat boost | @gramio/types/out/objects.d.ts:5442 |
|  `chat` | [`TelegramChat`](TelegramChat.md) | Chat which was boosted | @gramio/types/out/objects.d.ts:5438 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatFullInfo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatFullInfo

# Interface: TelegramChatFullInfo

Defined in: @gramio/types/out/objects.d.ts:289

This object contains full information about a chat.

[Documentation](https://core.telegram.org/bots/api/#chatfullinfo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `accent_color_id` | `number` | Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See [accent colors](https://core.telegram.org/bots/api#accent-colors) for more details. | @gramio/types/out/objects.d.ts:325 |
|  `accepted_gift_types` | [`TelegramAcceptedGiftTypes`](TelegramAcceptedGiftTypes.md) | Information about types of gifts that are accepted by the chat or by the corresponding user for private chats | @gramio/types/out/objects.d.ts:425 |
|  `active_usernames?` | `string`\[] | *Optional*. If non-empty, the list of all [active chat usernames](https://telegram.org/blog/topics-in-groups-collectible-usernames#collectible-usernames); for private chats, supergroups and channels | @gramio/types/out/objects.d.ts:337 |
|  `available_reactions?` | [`TelegramReactionType`](../type-aliases/TelegramReactionType.md)\[] | *Optional*. List of available reactions allowed in the chat. If omitted, then all [emoji reactions](https://core.telegram.org/bots/api#reactiontypeemoji) are allowed. | @gramio/types/out/objects.d.ts:365 |
|  `background_custom_emoji_id?` | `string` | *Optional*. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background | @gramio/types/out/objects.d.ts:369 |
|  `bio?` | `string` | *Optional*. Bio of the other party in a private chat | @gramio/types/out/objects.d.ts:389 |
|  `birthdate?` | [`TelegramBirthdate`](TelegramBirthdate.md) | *Optional*. For private chats, the date of birth of the user | @gramio/types/out/objects.d.ts:341 |
|  `business_intro?` | [`TelegramBusinessIntro`](TelegramBusinessIntro.md) | *Optional*. For private chats with business accounts, the intro of the business | @gramio/types/out/objects.d.ts:345 |
|  `business_location?` | [`TelegramBusinessLocation`](TelegramBusinessLocation.md) | *Optional*. For private chats with business accounts, the location of the business | @gramio/types/out/objects.d.ts:349 |
|  `business_opening_hours?` | [`TelegramBusinessOpeningHours`](TelegramBusinessOpeningHours.md) | *Optional*. For private chats with business accounts, the opening hours of the business | @gramio/types/out/objects.d.ts:353 |
|  `can_send_paid_media?` | `true` | *Optional*. *True*, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats. | @gramio/types/out/objects.d.ts:429 |
|  `can_set_sticker_set?` | `true` | *Optional*. *True*, if the bot can change the group sticker set | @gramio/types/out/objects.d.ts:465 |
|  `custom_emoji_sticker_set_name?` | `string` | *Optional*. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. | @gramio/types/out/objects.d.ts:469 |
|  `description?` | `string` | *Optional*. Description, for groups, supergroups and channel chats | @gramio/types/out/objects.d.ts:409 |
|  `emoji_status_custom_emoji_id?` | `string` | *Optional*. Custom emoji identifier of the emoji status of the chat or the other party in a private chat | @gramio/types/out/objects.d.ts:381 |
|  `emoji_status_expiration_date?` | `number` | *Optional*. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any | @gramio/types/out/objects.d.ts:385 |
|  `first_name?` | `string` | *Optional*. First name of the other party in a private chat | @gramio/types/out/objects.d.ts:309 |
|  `first_profile_audio?` | [`TelegramAudio`](TelegramAudio.md) | *Optional*. For private chats, the first audio added to the profile of the user | @gramio/types/out/objects.d.ts:485 |
|  `has_aggressive_anti_spam_enabled?` | `true` | *Optional*. *True*, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. | @gramio/types/out/objects.d.ts:445 |
|  `has_hidden_members?` | `true` | *Optional*. *True*, if non-administrators can only get the list of bots and administrators in the chat | @gramio/types/out/objects.d.ts:449 |
|  `has_private_forwards?` | `true` | *Optional*. *True*, if privacy settings of the other party in the private chat allows to use `tg://user?id=<user_id>` links only in chats with the user | @gramio/types/out/objects.d.ts:393 |
|  `has_protected_content?` | `true` | *Optional*. *True*, if messages from the chat can't be forwarded to other chats | @gramio/types/out/objects.d.ts:453 |
|  `has_restricted_voice_and_video_messages?` | `true` | *Optional*. *True*, if the privacy settings of the other party restrict sending voice and video note messages in the private chat | @gramio/types/out/objects.d.ts:397 |
|  `has_visible_history?` | `true` | *Optional*. *True*, if new chat members will have access to old messages; available only to chat administrators | @gramio/types/out/objects.d.ts:457 |
|  `id` | `number` | Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. | @gramio/types/out/objects.d.ts:293 |
|  `invite_link?` | `string` | *Optional*. Primary invite link, for groups, supergroups and channel chats | @gramio/types/out/objects.d.ts:413 |
|  `is_direct_messages?` | `true` | *Optional*. *True*, if the chat is the direct messages chat of a channel | @gramio/types/out/objects.d.ts:321 |
|  `is_forum?` | `true` | *Optional*. *True*, if the supergroup chat is a forum (has [topics](https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups) enabled) | @gramio/types/out/objects.d.ts:317 |
|  `join_by_request?` | `true` | *Optional*. *True*, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators | @gramio/types/out/objects.d.ts:405 |
|  `join_to_send_messages?` | `true` | *Optional*. *True*, if users need to join the supergroup before they can send messages | @gramio/types/out/objects.d.ts:401 |
|  `last_name?` | `string` | *Optional*. Last name of the other party in a private chat | @gramio/types/out/objects.d.ts:313 |
|  `linked_chat_id?` | `number` | *Optional*. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. | @gramio/types/out/objects.d.ts:473 |
|  `location?` | [`TelegramChatLocation`](TelegramChatLocation.md) | *Optional*. For supergroups, the location to which the supergroup is connected | @gramio/types/out/objects.d.ts:477 |
|  `max_reaction_count` | `number` | The maximum number of reactions that can be set on a message in the chat | @gramio/types/out/objects.d.ts:329 |
|  `message_auto_delete_time?` | `number` | *Optional*. The time after which all messages sent to the chat will be automatically deleted; in seconds | @gramio/types/out/objects.d.ts:441 |
|  `paid_message_star_count?` | `number` | *Optional*. The number of Telegram Stars a general user have to pay to send a message to the chat | @gramio/types/out/objects.d.ts:493 |
|  `parent_chat?` | [`TelegramChat`](TelegramChat.md) | *Optional*. Information about the corresponding channel chat; for direct messages chats only | @gramio/types/out/objects.d.ts:361 |
|  `permissions?` | [`TelegramChatPermissions`](TelegramChatPermissions.md) | *Optional*. Default chat member permissions, for groups and supergroups | @gramio/types/out/objects.d.ts:421 |
|  `personal_chat?` | [`TelegramChat`](TelegramChat.md) | *Optional*. For private chats, the personal channel of the user | @gramio/types/out/objects.d.ts:357 |
|  `photo?` | [`TelegramChatPhoto`](TelegramChatPhoto.md) | *Optional*. Chat photo | @gramio/types/out/objects.d.ts:333 |
|  `pinned_message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. The most recent pinned message (by sending date) | @gramio/types/out/objects.d.ts:417 |
|  `profile_accent_color_id?` | `number` | *Optional*. Identifier of the accent color for the chat's profile background. See [profile accent colors](https://core.telegram.org/bots/api#profile-accent-colors) for more details. | @gramio/types/out/objects.d.ts:373 |
|  `profile_background_custom_emoji_id?` | `string` | *Optional*. Custom emoji identifier of the emoji chosen by the chat for its profile background | @gramio/types/out/objects.d.ts:377 |
|  `rating?` | [`TelegramUserRating`](TelegramUserRating.md) | *Optional*. For private chats, the rating of the user if any | @gramio/types/out/objects.d.ts:481 |
|  `slow_mode_delay?` | `number` | *Optional*. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds | @gramio/types/out/objects.d.ts:433 |
|  `sticker_set_name?` | `string` | *Optional*. For supergroups, name of the group sticker set | @gramio/types/out/objects.d.ts:461 |
|  `title?` | `string` | *Optional*. Title, for supergroups, channels and group chats | @gramio/types/out/objects.d.ts:301 |
|  `type` | [`TelegramChatFullInfoType`](../type-aliases/TelegramChatFullInfoType.md) | Type of the chat, can be either “private”, “group”, “supergroup” or “channel” | @gramio/types/out/objects.d.ts:297 |
|  `unique_gift_colors?` | [`TelegramUniqueGiftColors`](TelegramUniqueGiftColors.md) | *Optional*. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews | @gramio/types/out/objects.d.ts:489 |
|  `unrestrict_boost_count?` | `number` | *Optional*. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions | @gramio/types/out/objects.d.ts:437 |
|  `username?` | `string` | *Optional*. Username, for private chats, supergroups and channels if available | @gramio/types/out/objects.d.ts:305 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatInviteLink.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatInviteLink

# Interface: TelegramChatInviteLink

Defined in: @gramio/types/out/objects.d.ts:3439

Represents an invite link for a chat.

[Documentation](https://core.telegram.org/bots/api/#chatinvitelink)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `creates_join_request` | `boolean` | *True*, if users joining the chat via the link need to be approved by chat administrators | @gramio/types/out/objects.d.ts:3451 |
|  `creator` | [`TelegramUser`](TelegramUser.md) | Creator of the link | @gramio/types/out/objects.d.ts:3447 |
|  `expire_date?` | `number` | *Optional*. Point in time (Unix timestamp) when the link will expire or has been expired | @gramio/types/out/objects.d.ts:3467 |
|  `invite_link` | `string` | The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”. | @gramio/types/out/objects.d.ts:3443 |
|  `is_primary` | `boolean` | *True*, if the link is primary | @gramio/types/out/objects.d.ts:3455 |
|  `is_revoked` | `boolean` | *True*, if the link is revoked | @gramio/types/out/objects.d.ts:3459 |
|  `member_limit?` | `number` | *Optional*. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 | @gramio/types/out/objects.d.ts:3471 |
|  `name?` | `string` | *Optional*. Invite link name | @gramio/types/out/objects.d.ts:3463 |
|  `pending_join_request_count?` | `number` | *Optional*. Number of pending join requests created using this link | @gramio/types/out/objects.d.ts:3475 |
|  `subscription_period?` | `number` | *Optional*. The number of seconds the subscription will be active for before the next payment | @gramio/types/out/objects.d.ts:3479 |
|  `subscription_price?` | `number` | *Optional*. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link | @gramio/types/out/objects.d.ts:3483 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatJoinRequest.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatJoinRequest

# Interface: TelegramChatJoinRequest

Defined in: @gramio/types/out/objects.d.ts:3891

Represents a join request sent to a chat.

[Documentation](https://core.telegram.org/bots/api/#chatjoinrequest)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `bio?` | `string` | *Optional*. Bio of the user. | @gramio/types/out/objects.d.ts:3911 |
|  `chat` | [`TelegramChat`](TelegramChat.md) | Chat to which the request was sent | @gramio/types/out/objects.d.ts:3895 |
|  `date` | `number` | Date the request was sent in Unix time | @gramio/types/out/objects.d.ts:3907 |
|  `from` | [`TelegramUser`](TelegramUser.md) | User that sent the join request | @gramio/types/out/objects.d.ts:3899 |
|  `invite_link?` | [`TelegramChatInviteLink`](TelegramChatInviteLink.md) | *Optional*. Chat invite link that was used by the user to send the join request | @gramio/types/out/objects.d.ts:3915 |
|  `user_chat_id` | `number` | Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user. | @gramio/types/out/objects.d.ts:3903 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatLocation.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatLocation

# Interface: TelegramChatLocation

Defined in: @gramio/types/out/objects.d.ts:4297

Represents a location to which a chat is connected.

[Documentation](https://core.telegram.org/bots/api/#chatlocation)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `address` | `string` | Location address; 1-64 characters, as defined by the chat owner | @gramio/types/out/objects.d.ts:4305 |
|  `location` | [`TelegramLocation`](TelegramLocation.md) | The location to which the supergroup is connected. Can't be a live location. | @gramio/types/out/objects.d.ts:4301 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatMemberAdministrator.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatMemberAdministrator

# Interface: TelegramChatMemberAdministrator

Defined in: @gramio/types/out/objects.d.ts:3651

Represents a [chat member](https://core.telegram.org/bots/api#chatmember) that has some additional privileges.

[Documentation](https://core.telegram.org/bots/api/#chatmemberadministrator)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `can_be_edited` | `boolean` | *True*, if the bot is allowed to edit administrator privileges of that user | @gramio/types/out/objects.d.ts:3663 |
|  `can_change_info` | `boolean` | *True*, if the user is allowed to change the chat title, photo and other settings | @gramio/types/out/objects.d.ts:3691 |
|  `can_delete_messages` | `boolean` | *True*, if the administrator can delete messages of other users | @gramio/types/out/objects.d.ts:3675 |
|  `can_delete_stories` | `boolean` | *True*, if the administrator can delete stories posted by other users | @gramio/types/out/objects.d.ts:3707 |
|  `can_edit_messages?` | `boolean` | *Optional*. *True*, if the administrator can edit messages of other users and can pin messages; for channels only | @gramio/types/out/objects.d.ts:3715 |
|  `can_edit_stories` | `boolean` | *True*, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive | @gramio/types/out/objects.d.ts:3703 |
|  `can_invite_users` | `boolean` | *True*, if the user is allowed to invite new users to the chat | @gramio/types/out/objects.d.ts:3695 |
|  `can_manage_chat` | `boolean` | *True*, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. | @gramio/types/out/objects.d.ts:3671 |
|  `can_manage_direct_messages?` | `boolean` | *Optional*. *True*, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only | @gramio/types/out/objects.d.ts:3727 |
|  `can_manage_tags?` | `boolean` | *Optional*. *True*, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can\_pin\_messages. | @gramio/types/out/objects.d.ts:3731 |
|  `can_manage_topics?` | `boolean` | *Optional*. *True*, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | @gramio/types/out/objects.d.ts:3723 |
|  `can_manage_video_chats` | `boolean` | *True*, if the administrator can manage video chats | @gramio/types/out/objects.d.ts:3679 |
|  `can_pin_messages?` | `boolean` | *Optional*. *True*, if the user is allowed to pin messages; for groups and supergroups only | @gramio/types/out/objects.d.ts:3719 |
|  `can_post_messages?` | `boolean` | *Optional*. *True*, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | @gramio/types/out/objects.d.ts:3711 |
|  `can_post_stories` | `boolean` | *True*, if the administrator can post stories to the chat | @gramio/types/out/objects.d.ts:3699 |
|  `can_promote_members` | `boolean` | *True*, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user) | @gramio/types/out/objects.d.ts:3687 |
|  `can_restrict_members` | `boolean` | *True*, if the administrator can restrict, ban or unban chat members, or access supergroup statistics | @gramio/types/out/objects.d.ts:3683 |
|  `custom_title?` | `string` | *Optional*. Custom title for this user | @gramio/types/out/objects.d.ts:3735 |
|  `is_anonymous` | `boolean` | *True*, if the user's presence in the chat is hidden | @gramio/types/out/objects.d.ts:3667 |
|  `status` | `"administrator"` | The member's status in the chat, always “administrator” | @gramio/types/out/objects.d.ts:3655 |
|  `user` | [`TelegramUser`](TelegramUser.md) | Information about the user | @gramio/types/out/objects.d.ts:3659 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatMemberBanned.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatMemberBanned

# Interface: TelegramChatMemberBanned

Defined in: @gramio/types/out/objects.d.ts:3871

Represents a [chat member](https://core.telegram.org/bots/api#chatmember) that was banned in the chat and can't return to the chat or view chat messages.

[Documentation](https://core.telegram.org/bots/api/#chatmemberbanned)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `status` | `"kicked"` | The member's status in the chat, always “kicked” | @gramio/types/out/objects.d.ts:3875 |
|  `until_date` | `number` | Date when restrictions will be lifted for this user; Unix time. If 0, then the user is banned forever | @gramio/types/out/objects.d.ts:3883 |
|  `user` | [`TelegramUser`](TelegramUser.md) | Information about the user | @gramio/types/out/objects.d.ts:3879 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatMemberLeft.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatMemberLeft

# Interface: TelegramChatMemberLeft

Defined in: @gramio/types/out/objects.d.ts:3855

Represents a [chat member](https://core.telegram.org/bots/api#chatmember) that isn't currently a member of the chat, but may join it themselves.

[Documentation](https://core.telegram.org/bots/api/#chatmemberleft)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `status` | `"left"` | The member's status in the chat, always “left” | @gramio/types/out/objects.d.ts:3859 |
|  `user` | [`TelegramUser`](TelegramUser.md) | Information about the user | @gramio/types/out/objects.d.ts:3863 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatMemberMember.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatMemberMember

# Interface: TelegramChatMemberMember

Defined in: @gramio/types/out/objects.d.ts:3743

Represents a [chat member](https://core.telegram.org/bots/api#chatmember) that has no additional privileges or restrictions.

[Documentation](https://core.telegram.org/bots/api/#chatmembermember)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `status` | `"member"` | The member's status in the chat, always “member” | @gramio/types/out/objects.d.ts:3747 |
|  `tag?` | `string` | *Optional*. Tag of the member | @gramio/types/out/objects.d.ts:3751 |
|  `until_date?` | `number` | *Optional*. Date when the user's subscription will expire; Unix time | @gramio/types/out/objects.d.ts:3759 |
|  `user` | [`TelegramUser`](TelegramUser.md) | Information about the user | @gramio/types/out/objects.d.ts:3755 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatMemberOwner.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatMemberOwner

# Interface: TelegramChatMemberOwner

Defined in: @gramio/types/out/objects.d.ts:3627

Represents a [chat member](https://core.telegram.org/bots/api#chatmember) that owns the chat and has all administrator privileges.

[Documentation](https://core.telegram.org/bots/api/#chatmemberowner)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `custom_title?` | `string` | *Optional*. Custom title for this user | @gramio/types/out/objects.d.ts:3643 |
|  `is_anonymous` | `boolean` | *True*, if the user's presence in the chat is hidden | @gramio/types/out/objects.d.ts:3639 |
|  `status` | `"creator"` | The member's status in the chat, always “creator” | @gramio/types/out/objects.d.ts:3631 |
|  `user` | [`TelegramUser`](TelegramUser.md) | Information about the user | @gramio/types/out/objects.d.ts:3635 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatMemberRestricted.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatMemberRestricted

# Interface: TelegramChatMemberRestricted

Defined in: @gramio/types/out/objects.d.ts:3767

Represents a [chat member](https://core.telegram.org/bots/api#chatmember) that is under certain restrictions in the chat. Supergroups only.

[Documentation](https://core.telegram.org/bots/api/#chatmemberrestricted)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `can_add_web_page_previews` | `boolean` | *True*, if the user is allowed to add web page previews to their messages | @gramio/types/out/objects.d.ts:3823 |
|  `can_change_info` | `boolean` | *True*, if the user is allowed to change the chat title, photo and other settings | @gramio/types/out/objects.d.ts:3831 |
|  `can_edit_tag` | `boolean` | *True*, if the user is allowed to edit their own tag | @gramio/types/out/objects.d.ts:3827 |
|  `can_invite_users` | `boolean` | *True*, if the user is allowed to invite new users to the chat | @gramio/types/out/objects.d.ts:3835 |
|  `can_manage_topics` | `boolean` | *True*, if the user is allowed to create forum topics | @gramio/types/out/objects.d.ts:3843 |
|  `can_pin_messages` | `boolean` | *True*, if the user is allowed to pin messages | @gramio/types/out/objects.d.ts:3839 |
|  `can_send_audios` | `boolean` | *True*, if the user is allowed to send audios | @gramio/types/out/objects.d.ts:3791 |
|  `can_send_documents` | `boolean` | *True*, if the user is allowed to send documents | @gramio/types/out/objects.d.ts:3795 |
|  `can_send_messages` | `boolean` | *True*, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues | @gramio/types/out/objects.d.ts:3787 |
|  `can_send_other_messages` | `boolean` | *True*, if the user is allowed to send animations, games, stickers and use inline bots | @gramio/types/out/objects.d.ts:3819 |
|  `can_send_photos` | `boolean` | *True*, if the user is allowed to send photos | @gramio/types/out/objects.d.ts:3799 |
|  `can_send_polls` | `boolean` | *True*, if the user is allowed to send polls and checklists | @gramio/types/out/objects.d.ts:3815 |
|  `can_send_video_notes` | `boolean` | *True*, if the user is allowed to send video notes | @gramio/types/out/objects.d.ts:3807 |
|  `can_send_videos` | `boolean` | *True*, if the user is allowed to send videos | @gramio/types/out/objects.d.ts:3803 |
|  `can_send_voice_notes` | `boolean` | *True*, if the user is allowed to send voice notes | @gramio/types/out/objects.d.ts:3811 |
|  `is_member` | `boolean` | *True*, if the user is a member of the chat at the moment of the request | @gramio/types/out/objects.d.ts:3783 |
|  `status` | `"restricted"` | The member's status in the chat, always “restricted” | @gramio/types/out/objects.d.ts:3771 |
|  `tag?` | `string` | *Optional*. Tag of the member | @gramio/types/out/objects.d.ts:3775 |
|  `until_date` | `number` | Date when restrictions will be lifted for this user; Unix time. If 0, then the user is restricted forever | @gramio/types/out/objects.d.ts:3847 |
|  `user` | [`TelegramUser`](TelegramUser.md) | Information about the user | @gramio/types/out/objects.d.ts:3779 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatMemberUpdated.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatMemberUpdated

# Interface: TelegramChatMemberUpdated

Defined in: @gramio/types/out/objects.d.ts:3567

This object represents changes in the status of a chat member.

[Documentation](https://core.telegram.org/bots/api/#chatmemberupdated)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat` | [`TelegramChat`](TelegramChat.md) | Chat the user belongs to | @gramio/types/out/objects.d.ts:3571 |
|  `date` | `number` | Date the change was done in Unix time | @gramio/types/out/objects.d.ts:3579 |
|  `from` | [`TelegramUser`](TelegramUser.md) | Performer of the action, which resulted in the change | @gramio/types/out/objects.d.ts:3575 |
|  `invite_link?` | [`TelegramChatInviteLink`](TelegramChatInviteLink.md) | *Optional*. Chat invite link, which was used by the user to join the chat; for joining by invite link events only. | @gramio/types/out/objects.d.ts:3591 |
|  `new_chat_member` | [`TelegramChatMember`](../type-aliases/TelegramChatMember.md) | New information about the chat member | @gramio/types/out/objects.d.ts:3587 |
|  `old_chat_member` | [`TelegramChatMember`](../type-aliases/TelegramChatMember.md) | Previous information about the chat member | @gramio/types/out/objects.d.ts:3583 |
|  `via_chat_folder_invite_link?` | `boolean` | *Optional*. *True*, if the user joined the chat via a chat folder invite link | @gramio/types/out/objects.d.ts:3599 |
|  `via_join_request?` | `boolean` | *Optional*. *True*, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator | @gramio/types/out/objects.d.ts:3595 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatOwnerChanged.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatOwnerChanged

# Interface: TelegramChatOwnerChanged

Defined in: @gramio/types/out/objects.d.ts:5486

Describes a service message about an ownership change in the chat.

[Documentation](https://core.telegram.org/bots/api/#chatownerchanged)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `new_owner` | [`TelegramUser`](TelegramUser.md) | The new owner of the chat | @gramio/types/out/objects.d.ts:5490 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatOwnerLeft.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatOwnerLeft

# Interface: TelegramChatOwnerLeft

Defined in: @gramio/types/out/objects.d.ts:5474

Describes a service message about the chat owner leaving the chat.

[Documentation](https://core.telegram.org/bots/api/#chatownerleft)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `new_owner?` | [`TelegramUser`](TelegramUser.md) | *Optional*. The user which will be the new owner of the chat if the previous owner does not return to the chat | @gramio/types/out/objects.d.ts:5478 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatPermissions.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatPermissions

# Interface: TelegramChatPermissions

Defined in: @gramio/types/out/objects.d.ts:3923

Describes actions that a non-administrator user is allowed to take in a chat.

[Documentation](https://core.telegram.org/bots/api/#chatpermissions)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `can_add_web_page_previews?` | `boolean` | *Optional*. *True*, if the user is allowed to add web page previews to their messages | @gramio/types/out/objects.d.ts:3963 |
|  `can_change_info?` | `boolean` | *Optional*. *True*, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups | @gramio/types/out/objects.d.ts:3971 |
|  `can_edit_tag?` | `boolean` | *Optional*. *True*, if the user is allowed to edit their own tag | @gramio/types/out/objects.d.ts:3967 |
|  `can_invite_users?` | `boolean` | *Optional*. *True*, if the user is allowed to invite new users to the chat | @gramio/types/out/objects.d.ts:3975 |
|  `can_manage_topics?` | `boolean` | *Optional*. *True*, if the user is allowed to create forum topics. If omitted defaults to the value of can\_pin\_messages | @gramio/types/out/objects.d.ts:3983 |
|  `can_pin_messages?` | `boolean` | *Optional*. *True*, if the user is allowed to pin messages. Ignored in public supergroups | @gramio/types/out/objects.d.ts:3979 |
|  `can_send_audios?` | `boolean` | *Optional*. *True*, if the user is allowed to send audios | @gramio/types/out/objects.d.ts:3931 |
|  `can_send_documents?` | `boolean` | *Optional*. *True*, if the user is allowed to send documents | @gramio/types/out/objects.d.ts:3935 |
|  `can_send_messages?` | `boolean` | *Optional*. *True*, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues | @gramio/types/out/objects.d.ts:3927 |
|  `can_send_other_messages?` | `boolean` | *Optional*. *True*, if the user is allowed to send animations, games, stickers and use inline bots | @gramio/types/out/objects.d.ts:3959 |
|  `can_send_photos?` | `boolean` | *Optional*. *True*, if the user is allowed to send photos | @gramio/types/out/objects.d.ts:3939 |
|  `can_send_polls?` | `boolean` | *Optional*. *True*, if the user is allowed to send polls and checklists | @gramio/types/out/objects.d.ts:3955 |
|  `can_send_video_notes?` | `boolean` | *Optional*. *True*, if the user is allowed to send video notes | @gramio/types/out/objects.d.ts:3947 |
|  `can_send_videos?` | `boolean` | *Optional*. *True*, if the user is allowed to send videos | @gramio/types/out/objects.d.ts:3943 |
|  `can_send_voice_notes?` | `boolean` | *Optional*. *True*, if the user is allowed to send voice notes | @gramio/types/out/objects.d.ts:3951 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatPhoto.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatPhoto

# Interface: TelegramChatPhoto

Defined in: @gramio/types/out/objects.d.ts:3415

This object represents a chat photo.

[Documentation](https://core.telegram.org/bots/api/#chatphoto)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `big_file_id` | `string` | File identifier of big (640x640) chat photo. This file\_id can be used only for photo download and only for as long as the photo is not changed. | @gramio/types/out/objects.d.ts:3427 |
|  `big_file_unique_id` | `string` | Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:3431 |
|  `small_file_id` | `string` | File identifier of small (160x160) chat photo. This file\_id can be used only for photo download and only for as long as the photo is not changed. | @gramio/types/out/objects.d.ts:3419 |
|  `small_file_unique_id` | `string` | Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:3423 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChatShared.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatShared

# Interface: TelegramChatShared

Defined in: @gramio/types/out/objects.d.ts:2485

This object contains information about a chat that was shared with the bot using a [KeyboardButtonRequestChat](https://core.telegram.org/bots/api#keyboardbuttonrequestchat) button.

[Documentation](https://core.telegram.org/bots/api/#chatshared)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `number` | Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means. | @gramio/types/out/objects.d.ts:2493 |
|  `photo?` | [`TelegramPhotoSize`](TelegramPhotoSize.md)\[] | *Optional*. Available sizes of the chat photo, if the photo was requested by the bot | @gramio/types/out/objects.d.ts:2505 |
|  `request_id` | `number` | Identifier of the request | @gramio/types/out/objects.d.ts:2489 |
|  `title?` | `string` | *Optional*. Title of the chat, if the title was requested by the bot. | @gramio/types/out/objects.d.ts:2497 |
|  `username?` | `string` | *Optional*. Username of the chat, if the username was requested by the bot and available. | @gramio/types/out/objects.d.ts:2501 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChecklist.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChecklist

# Interface: TelegramChecklist

Defined in: @gramio/types/out/objects.d.ts:1931

Describes a checklist.

[Documentation](https://core.telegram.org/bots/api/#checklist)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `others_can_add_tasks?` | `true` | *Optional*. *True*, if users other than the creator of the list can add tasks to the list | @gramio/types/out/objects.d.ts:1947 |
|  `others_can_mark_tasks_as_done?` | `true` | *Optional*. *True*, if users other than the creator of the list can mark tasks as done or not done | @gramio/types/out/objects.d.ts:1951 |
|  `tasks` | [`TelegramChecklistTask`](TelegramChecklistTask.md)\[] | List of tasks in the checklist | @gramio/types/out/objects.d.ts:1943 |
|  `title` | `string` | Title of the checklist | @gramio/types/out/objects.d.ts:1935 |
|  `title_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. Special entities that appear in the checklist title | @gramio/types/out/objects.d.ts:1939 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChecklistTask.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChecklistTask

# Interface: TelegramChecklistTask

Defined in: @gramio/types/out/objects.d.ts:1899

Describes a task in a checklist.

[Documentation](https://core.telegram.org/bots/api/#checklisttask)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `completed_by_chat?` | [`TelegramChat`](TelegramChat.md) | *Optional*. Chat that completed the task; omitted if the task wasn't completed by a chat | @gramio/types/out/objects.d.ts:1919 |
|  `completed_by_user?` | [`TelegramUser`](TelegramUser.md) | *Optional*. User that completed the task; omitted if the task wasn't completed by a user | @gramio/types/out/objects.d.ts:1915 |
|  `completion_date?` | `number` | *Optional*. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed | @gramio/types/out/objects.d.ts:1923 |
|  `id` | `number` | Unique identifier of the task | @gramio/types/out/objects.d.ts:1903 |
|  `text` | `string` | Text of the task | @gramio/types/out/objects.d.ts:1907 |
|  `text_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. Special entities that appear in the task text | @gramio/types/out/objects.d.ts:1911 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChecklistTasksAdded.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChecklistTasksAdded

# Interface: TelegramChecklistTasksAdded

Defined in: @gramio/types/out/objects.d.ts:2035

Describes a service message about tasks added to a checklist.

[Documentation](https://core.telegram.org/bots/api/#checklisttasksadded)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `checklist_message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. Message containing the checklist to which the tasks were added. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply\_to\_message* field even if it itself is a reply. | @gramio/types/out/objects.d.ts:2039 |
|  `tasks` | [`TelegramChecklistTask`](TelegramChecklistTask.md)\[] | List of tasks added to the checklist | @gramio/types/out/objects.d.ts:2043 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChecklistTasksDone.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChecklistTasksDone

# Interface: TelegramChecklistTasksDone

Defined in: @gramio/types/out/objects.d.ts:2015

Describes a service message about checklist tasks marked as done or not done.

[Documentation](https://core.telegram.org/bots/api/#checklisttasksdone)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `checklist_message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. Message containing the checklist whose tasks were marked as done or not done. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply\_to\_message* field even if it itself is a reply. | @gramio/types/out/objects.d.ts:2019 |
|  `marked_as_done_task_ids?` | `number`\[] | *Optional*. Identifiers of the tasks that were marked as done | @gramio/types/out/objects.d.ts:2023 |
|  `marked_as_not_done_task_ids?` | `number`\[] | *Optional*. Identifiers of the tasks that were marked as not done | @gramio/types/out/objects.d.ts:2027 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramChosenInlineResult.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChosenInlineResult

# Interface: TelegramChosenInlineResult

Defined in: @gramio/types/out/objects.d.ts:7676

Represents a [result](https://core.telegram.org/bots/api#inlinequeryresult) of an inline query that was chosen by the user and sent to their chat partner.

[Documentation](https://core.telegram.org/bots/api/#choseninlineresult)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `from` | [`TelegramUser`](TelegramUser.md) | The user that chose the result | @gramio/types/out/objects.d.ts:7684 |
|  `inline_message_id?` | `string` | *Optional*. Identifier of the sent inline message. Available only if there is an [inline keyboard](https://core.telegram.org/bots/api#inlinekeyboardmarkup) attached to the message. Will be also received in [callback queries](https://core.telegram.org/bots/api#callbackquery) and can be used to [edit](https://core.telegram.org/bots/api#updating-messages) the message. | @gramio/types/out/objects.d.ts:7692 |
|  `location?` | [`TelegramLocation`](TelegramLocation.md) | *Optional*. Sender location, only for bots that require user location | @gramio/types/out/objects.d.ts:7688 |
|  `query` | `string` | The query that was used to obtain the result | @gramio/types/out/objects.d.ts:7696 |
|  `result_id` | `string` | The unique identifier for the result that was chosen | @gramio/types/out/objects.d.ts:7680 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramContact.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramContact

# Interface: TelegramContact

Defined in: @gramio/types/out/objects.d.ts:1725

This object represents a phone contact.

[Documentation](https://core.telegram.org/bots/api/#contact)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `first_name` | `string` | Contact's first name | @gramio/types/out/objects.d.ts:1733 |
|  `last_name?` | `string` | *Optional*. Contact's last name | @gramio/types/out/objects.d.ts:1737 |
|  `phone_number` | `string` | Contact's phone number | @gramio/types/out/objects.d.ts:1729 |
|  `user_id?` | `number` | *Optional*. Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. | @gramio/types/out/objects.d.ts:1741 |
|  `vcard?` | `string` | *Optional*. Additional data about the contact in the form of a [vCard](https://en.wikipedia.org/wiki/VCard) | @gramio/types/out/objects.d.ts:1745 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramCopyTextButton.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramCopyTextButton

# Interface: TelegramCopyTextButton

Defined in: @gramio/types/out/objects.d.ts:3347

This object represents an inline keyboard button that copies specified text to the clipboard.

[Documentation](https://core.telegram.org/bots/api/#copytextbutton)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `text` | `string` | The text to be copied to the clipboard; 1-256 characters | @gramio/types/out/objects.d.ts:3351 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramDice.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramDice

# Interface: TelegramDice

Defined in: @gramio/types/out/objects.d.ts:1753

This object represents an animated emoji that displays a random value.

[Documentation](https://core.telegram.org/bots/api/#dice)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `emoji` | `string` | Emoji on which the dice throw animation is based | @gramio/types/out/objects.d.ts:1757 |
|  `value` | `number` | Value of the dice, 1-6 for “![🎲](https://telegram.org/img/emoji/40/F09F8EB2.png)”, “![🎯](https://telegram.org/img/emoji/40/F09F8EAF.png)” and “![🎳](https://telegram.org/img/emoji/40/F09F8EB3.png)” base emoji, 1-5 for “![🏀](https://telegram.org/img/emoji/40/F09F8F80.png)” and “![⚽](https://telegram.org/img/emoji/40/E29ABD.png)” base emoji, 1-64 for “![🎰](https://telegram.org/img/emoji/40/F09F8EB0.png)” base emoji | @gramio/types/out/objects.d.ts:1761 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramDirectMessagePriceChanged.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramDirectMessagePriceChanged

# Interface: TelegramDirectMessagePriceChanged

Defined in: @gramio/types/out/objects.d.ts:2588

Describes a service message about a change in the price of direct messages sent to a channel chat.

[Documentation](https://core.telegram.org/bots/api/#directmessagepricechanged)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `are_direct_messages_enabled` | `boolean` | *True*, if direct messages are enabled for the channel chat; false otherwise | @gramio/types/out/objects.d.ts:2592 |
|  `direct_message_star_count?` | `number` | *Optional*. The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0. | @gramio/types/out/objects.d.ts:2596 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramDirectMessagesTopic.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramDirectMessagesTopic

# Interface: TelegramDirectMessagesTopic

Defined in: @gramio/types/out/objects.d.ts:2923

Describes a topic of a direct messages chat.

[Documentation](https://core.telegram.org/bots/api/#directmessagestopic)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `topic_id` | `number` | Unique identifier of the topic. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. | @gramio/types/out/objects.d.ts:2927 |
|  `user?` | [`TelegramUser`](TelegramUser.md) | *Optional*. Information about the user that created the topic. Currently, it is always present | @gramio/types/out/objects.d.ts:2931 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramDocument.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramDocument

# Interface: TelegramDocument

Defined in: @gramio/types/out/objects.d.ts:1441

This object represents a general file (as opposed to [photos](https://core.telegram.org/bots/api#photosize), [voice messages](https://core.telegram.org/bots/api#voice) and [audio files](https://core.telegram.org/bots/api#audio)).

[Documentation](https://core.telegram.org/bots/api/#document)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `file_id` | `string` | Identifier for this file, which can be used to download or reuse the file | @gramio/types/out/objects.d.ts:1445 |
|  `file_name?` | `string` | *Optional*. Original filename as defined by the sender | @gramio/types/out/objects.d.ts:1457 |
|  `file_size?` | `number` | *Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. | @gramio/types/out/objects.d.ts:1465 |
|  `file_unique_id` | `string` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:1449 |
|  `mime_type?` | `string` | *Optional*. MIME type of the file as defined by the sender | @gramio/types/out/objects.d.ts:1461 |
|  `thumbnail?` | [`TelegramPhotoSize`](TelegramPhotoSize.md) | *Optional*. Document thumbnail as defined by the sender | @gramio/types/out/objects.d.ts:1453 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramEncryptedCredentials.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramEncryptedCredentials

# Interface: TelegramEncryptedCredentials

Defined in: @gramio/types/out/objects.d.ts:8410

Describes data required for decrypting and authenticating [EncryptedPassportElement](https://core.telegram.org/bots/api#encryptedpassportelement). See the [Telegram Passport Documentation](https://core.telegram.org/passport#receiving-information) for a complete description of the data decryption and authentication processes.

[Documentation](https://core.telegram.org/bots/api/#encryptedcredentials)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `data` | `string` | Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for [EncryptedPassportElement](https://core.telegram.org/bots/api#encryptedpassportelement) decryption and authentication | @gramio/types/out/objects.d.ts:8414 |
|  `hash` | `string` | Base64-encoded data hash for data authentication | @gramio/types/out/objects.d.ts:8418 |
|  `secret` | `string` | Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption | @gramio/types/out/objects.d.ts:8422 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramEncryptedPassportElement.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramEncryptedPassportElement

# Interface: TelegramEncryptedPassportElement

Defined in: @gramio/types/out/objects.d.ts:8362

Describes documents or other Telegram Passport elements shared with the bot by the user.

[Documentation](https://core.telegram.org/bots/api/#encryptedpassportelement)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `data?` | `string` | *Optional*. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for “personal\_details”, “passport”, “driver\_license”, “identity\_card”, “internal\_passport” and “address” types. Can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api#encryptedcredentials). | @gramio/types/out/objects.d.ts:8370 |
|  `email?` | `string` | *Optional*. User's verified email address; available only for “email” type | @gramio/types/out/objects.d.ts:8378 |
|  `files?` | [`TelegramPassportFile`](TelegramPassportFile.md)\[] | *Optional*. Array of encrypted files with documents provided by the user; available only for “utility\_bill”, “bank\_statement”, “rental\_agreement”, “passport\_registration” and “temporary\_registration” types. Files can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api#encryptedcredentials). | @gramio/types/out/objects.d.ts:8382 |
|  `front_side?` | [`TelegramPassportFile`](TelegramPassportFile.md) | *Optional*. Encrypted file with the front side of the document, provided by the user; available only for “passport”, “driver\_license”, “identity\_card” and “internal\_passport”. The file can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api#encryptedcredentials). | @gramio/types/out/objects.d.ts:8386 |
|  `hash` | `string` | Base64-encoded element hash for using in [PassportElementErrorUnspecified](https://core.telegram.org/bots/api#passportelementerrorunspecified) | @gramio/types/out/objects.d.ts:8402 |
|  `phone_number?` | `string` | *Optional*. User's verified phone number; available only for “phone\_number” type | @gramio/types/out/objects.d.ts:8374 |
|  `reverse_side?` | [`TelegramPassportFile`](TelegramPassportFile.md) | *Optional*. Encrypted file with the reverse side of the document, provided by the user; available only for “driver\_license” and “identity\_card”. The file can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api#encryptedcredentials). | @gramio/types/out/objects.d.ts:8390 |
|  `selfie?` | [`TelegramPassportFile`](TelegramPassportFile.md) | *Optional*. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for “passport”, “driver\_license”, “identity\_card” and “internal\_passport”. The file can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api#encryptedcredentials). | @gramio/types/out/objects.d.ts:8394 |
|  `translation?` | [`TelegramPassportFile`](TelegramPassportFile.md)\[] | *Optional*. Array of encrypted files with translated versions of documents provided by the user; available if requested for “passport”, “driver\_license”, “identity\_card”, “internal\_passport”, “utility\_bill”, “bank\_statement”, “rental\_agreement”, “passport\_registration” and “temporary\_registration” types. Files can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api#encryptedcredentials). | @gramio/types/out/objects.d.ts:8398 |
|  `type` | [`TelegramEncryptedPassportElementType`](../type-aliases/TelegramEncryptedPassportElementType.md) | Element type. One of “personal\_details”, “passport”, “driver\_license”, “identity\_card”, “internal\_passport”, “address”, “utility\_bill”, “bank\_statement”, “rental\_agreement”, “passport\_registration”, “temporary\_registration”, “phone\_number”, “email”. | @gramio/types/out/objects.d.ts:8366 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramExternalReplyInfo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramExternalReplyInfo

# Interface: TelegramExternalReplyInfo

Defined in: @gramio/types/out/objects.d.ts:1069

This object contains information about a message that is being replied to, which may come from another chat or forum topic.

[Documentation](https://core.telegram.org/bots/api/#externalreplyinfo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `animation?` | [`TelegramAnimation`](TelegramAnimation.md) | *Optional*. Message is an animation, information about the animation | @gramio/types/out/objects.d.ts:1089 |
|  `audio?` | [`TelegramAudio`](TelegramAudio.md) | *Optional*. Message is an audio file, information about the file | @gramio/types/out/objects.d.ts:1093 |
|  `chat?` | [`TelegramChat`](TelegramChat.md) | *Optional*. Chat the original message belongs to. Available only if the chat is a supergroup or a channel. | @gramio/types/out/objects.d.ts:1077 |
|  `checklist?` | [`TelegramChecklist`](TelegramChecklist.md) | *Optional*. Message is a checklist | @gramio/types/out/objects.d.ts:1133 |
|  `contact?` | [`TelegramContact`](TelegramContact.md) | *Optional*. Message is a shared contact, information about the contact | @gramio/types/out/objects.d.ts:1137 |
|  `dice?` | [`TelegramDice`](TelegramDice.md) | *Optional*. Message is a dice with random value | @gramio/types/out/objects.d.ts:1141 |
|  `document?` | [`TelegramDocument`](TelegramDocument.md) | *Optional*. Message is a general file, information about the file | @gramio/types/out/objects.d.ts:1097 |
|  `game?` | [`TelegramGame`](TelegramGame.md) | *Optional*. Message is a game, information about the game. [More about games »](https://core.telegram.org/bots/api#games) | @gramio/types/out/objects.d.ts:1145 |
|  `giveaway?` | [`TelegramGiveaway`](TelegramGiveaway.md) | *Optional*. Message is a scheduled giveaway, information about the giveaway | @gramio/types/out/objects.d.ts:1149 |
|  `giveaway_winners?` | [`TelegramGiveawayWinners`](TelegramGiveawayWinners.md) | *Optional*. A giveaway with public winners was completed | @gramio/types/out/objects.d.ts:1153 |
|  `has_media_spoiler?` | `true` | *Optional*. *True*, if the message media is covered by a spoiler animation | @gramio/types/out/objects.d.ts:1129 |
|  `invoice?` | [`TelegramInvoice`](TelegramInvoice.md) | *Optional*. Message is an invoice for a [payment](https://core.telegram.org/bots/api#payments), information about the invoice. [More about payments »](https://core.telegram.org/bots/api#payments) | @gramio/types/out/objects.d.ts:1157 |
|  `link_preview_options?` | [`TelegramLinkPreviewOptions`](TelegramLinkPreviewOptions.md) | *Optional*. Options used for link preview generation for the original message, if it is a text message | @gramio/types/out/objects.d.ts:1085 |
|  `location?` | [`TelegramLocation`](TelegramLocation.md) | *Optional*. Message is a shared location, information about the location | @gramio/types/out/objects.d.ts:1161 |
|  `message_id?` | `number` | *Optional*. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel. | @gramio/types/out/objects.d.ts:1081 |
|  `origin` | [`TelegramMessageOrigin`](../type-aliases/TelegramMessageOrigin.md) | Origin of the message replied to by the given message | @gramio/types/out/objects.d.ts:1073 |
|  `paid_media?` | [`TelegramPaidMediaInfo`](TelegramPaidMediaInfo.md) | *Optional*. Message contains paid media; information about the paid media | @gramio/types/out/objects.d.ts:1101 |
|  `photo?` | [`TelegramPhotoSize`](TelegramPhotoSize.md)\[] | *Optional*. Message is a photo, available sizes of the photo | @gramio/types/out/objects.d.ts:1105 |
|  `poll?` | [`TelegramPoll`](TelegramPoll.md) | *Optional*. Message is a native poll, information about the poll | @gramio/types/out/objects.d.ts:1165 |
|  `sticker?` | [`TelegramSticker`](TelegramSticker.md) | *Optional*. Message is a sticker, information about the sticker | @gramio/types/out/objects.d.ts:1109 |
|  `story?` | [`TelegramStory`](TelegramStory.md) | *Optional*. Message is a forwarded story | @gramio/types/out/objects.d.ts:1113 |
|  `venue?` | [`TelegramVenue`](TelegramVenue.md) | *Optional*. Message is a venue, information about the venue | @gramio/types/out/objects.d.ts:1169 |
|  `video?` | [`TelegramVideo`](TelegramVideo.md) | *Optional*. Message is a video, information about the video | @gramio/types/out/objects.d.ts:1117 |
|  `video_note?` | [`TelegramVideoNote`](TelegramVideoNote.md) | *Optional*. Message is a [video note](https://telegram.org/blog/video-messages-and-telescope), information about the video message | @gramio/types/out/objects.d.ts:1121 |
|  `voice?` | [`TelegramVoice`](TelegramVoice.md) | *Optional*. Message is a voice message, information about the file | @gramio/types/out/objects.d.ts:1125 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramFile.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramFile

# Interface: TelegramFile

Defined in: @gramio/types/out/objects.d.ts:2973

This object represents a file ready to be downloaded. The file can be downloaded via the link `https://api.telegram.org/file/bot<token>/<file_path>`. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling [getFile](https://core.telegram.org/bots/api#getfile).

> The maximum file size to download is 20 MB

[Documentation](https://core.telegram.org/bots/api/#file)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `file_id` | `string` | Identifier for this file, which can be used to download or reuse the file | @gramio/types/out/objects.d.ts:2977 |
|  `file_path?` | `string` | *Optional*. File path. Use `https://api.telegram.org/file/bot<token>/<file_path>` to get the file. | @gramio/types/out/objects.d.ts:2989 |
|  `file_size?` | `number` | *Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. | @gramio/types/out/objects.d.ts:2985 |
|  `file_unique_id` | `string` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:2981 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramForceReply.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramForceReply

# Interface: TelegramForceReply

Defined in: @gramio/types/out/objects.d.ts:3395

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](https://core.telegram.org/bots/features#privacy-mode). Not supported in channels and for messages sent on behalf of a Telegram Business account.

[Documentation](https://core.telegram.org/bots/api/#forcereply)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `force_reply` | `true` | Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply' | @gramio/types/out/objects.d.ts:3399 |
|  `input_field_placeholder?` | `string` | *Optional*. The placeholder to be shown in the input field when the reply is active; 1-64 characters | @gramio/types/out/objects.d.ts:3403 |
|  `selective?` | `boolean` | *Optional*. 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](https://core.telegram.org/bots/api#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. | @gramio/types/out/objects.d.ts:3407 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramForumTopic.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramForumTopic

# Interface: TelegramForumTopic

Defined in: @gramio/types/out/objects.d.ts:4522

This object represents a forum topic.

[Documentation](https://core.telegram.org/bots/api/#forumtopic)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `icon_color` | `number` | Color of the topic icon in RGB format | @gramio/types/out/objects.d.ts:4534 |
|  `icon_custom_emoji_id?` | `string` | *Optional*. Unique identifier of the custom emoji shown as the topic icon | @gramio/types/out/objects.d.ts:4538 |
|  `is_name_implicit?` | `true` | *Optional*. *True*, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot | @gramio/types/out/objects.d.ts:4542 |
|  `message_thread_id` | `number` | Unique identifier of the forum topic | @gramio/types/out/objects.d.ts:4526 |
|  `name` | `string` | Name of the topic | @gramio/types/out/objects.d.ts:4530 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramForumTopicClosed.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramForumTopicClosed

# Interface: TelegramForumTopicClosed

Defined in: @gramio/types/out/objects.d.ts:2397

This object represents a service message about a forum topic closed in the chat. Currently holds no information.

[Documentation](https://core.telegram.org/bots/api/#forumtopicclosed)

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramForumTopicCreated.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramForumTopicCreated

# Interface: TelegramForumTopicCreated

Defined in: @gramio/types/out/objects.d.ts:2373

This object represents a service message about a new forum topic created in the chat.

[Documentation](https://core.telegram.org/bots/api/#forumtopiccreated)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `icon_color` | `number` | Color of the topic icon in RGB format | @gramio/types/out/objects.d.ts:2381 |
|  `icon_custom_emoji_id?` | `string` | *Optional*. Unique identifier of the custom emoji shown as the topic icon | @gramio/types/out/objects.d.ts:2385 |
|  `is_name_implicit?` | `true` | *Optional*. *True*, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot | @gramio/types/out/objects.d.ts:2389 |
|  `name` | `string` | Name of the topic | @gramio/types/out/objects.d.ts:2377 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramForumTopicEdited.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramForumTopicEdited

# Interface: TelegramForumTopicEdited

Defined in: @gramio/types/out/objects.d.ts:2404

This object represents a service message about an edited forum topic.

[Documentation](https://core.telegram.org/bots/api/#forumtopicedited)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `icon_custom_emoji_id?` | `string` | *Optional*. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed | @gramio/types/out/objects.d.ts:2412 |
|  `name?` | `string` | *Optional*. New name of the topic, if it was edited | @gramio/types/out/objects.d.ts:2408 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramForumTopicReopened.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramForumTopicReopened

# Interface: TelegramForumTopicReopened

Defined in: @gramio/types/out/objects.d.ts:2420

This object represents a service message about a forum topic reopened in the chat. Currently holds no information.

[Documentation](https://core.telegram.org/bots/api/#forumtopicreopened)

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramGame.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramGame

# Interface: TelegramGame

Defined in: @gramio/types/out/objects.d.ts:8736

This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.

[Documentation](https://core.telegram.org/bots/api/#game)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `animation?` | [`TelegramAnimation`](TelegramAnimation.md) | *Optional*. Animation that will be displayed in the game message in chats. Upload via [BotFather](https://t.me/botfather) | @gramio/types/out/objects.d.ts:8760 |
|  `description` | `string` | Description of the game | @gramio/types/out/objects.d.ts:8744 |
|  `photo` | [`TelegramPhotoSize`](TelegramPhotoSize.md)\[] | Photo that will be displayed in the game message in chats. | @gramio/types/out/objects.d.ts:8748 |
|  `text?` | `string` | *Optional*. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls [setGameScore](https://core.telegram.org/bots/api#setgamescore), or manually edited using [editMessageText](https://core.telegram.org/bots/api#editmessagetext). 0-4096 characters. | @gramio/types/out/objects.d.ts:8752 |
|  `text_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. Special entities that appear in *text*, such as usernames, URLs, bot commands, etc. | @gramio/types/out/objects.d.ts:8756 |
|  `title` | `string` | Title of the game | @gramio/types/out/objects.d.ts:8740 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramGameHighScore.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramGameHighScore

# Interface: TelegramGameHighScore

Defined in: @gramio/types/out/objects.d.ts:8775

This object represents one row of the high scores table for a game.

[Documentation](https://core.telegram.org/bots/api/#gamehighscore)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `position` | `number` | Position in high score table for the game | @gramio/types/out/objects.d.ts:8779 |
|  `score` | `number` | Score | @gramio/types/out/objects.d.ts:8787 |
|  `user` | [`TelegramUser`](TelegramUser.md) | User | @gramio/types/out/objects.d.ts:8783 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramGeneralForumTopicHidden.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramGeneralForumTopicHidden

# Interface: TelegramGeneralForumTopicHidden

Defined in: @gramio/types/out/objects.d.ts:2427

This object represents a service message about General forum topic hidden in the chat. Currently holds no information.

[Documentation](https://core.telegram.org/bots/api/#generalforumtopichidden)

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramGeneralForumTopicUnhidden.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramGeneralForumTopicUnhidden

# Interface: TelegramGeneralForumTopicUnhidden

Defined in: @gramio/types/out/objects.d.ts:2434

This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.

[Documentation](https://core.telegram.org/bots/api/#generalforumtopicunhidden)

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramGift.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramGift

# Interface: TelegramGift

Defined in: @gramio/types/out/objects.d.ts:4570

This object represents a gift that can be sent by the bot.

[Documentation](https://core.telegram.org/bots/api/#gift)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `background?` | [`TelegramGiftBackground`](TelegramGiftBackground.md) | *Optional*. Background of the gift | @gramio/types/out/objects.d.ts:4614 |
|  `has_colors?` | `true` | *Optional*. *True*, if the gift can be used (after being upgraded) to customize a user's appearance | @gramio/types/out/objects.d.ts:4594 |
|  `id` | `string` | Unique identifier of the gift | @gramio/types/out/objects.d.ts:4574 |
|  `is_premium?` | `true` | *Optional*. *True*, if the gift can only be purchased by Telegram Premium subscribers | @gramio/types/out/objects.d.ts:4590 |
|  `personal_remaining_count?` | `number` | *Optional*. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only | @gramio/types/out/objects.d.ts:4610 |
|  `personal_total_count?` | `number` | *Optional*. The total number of gifts of this type that can be sent by the bot; for limited gifts only | @gramio/types/out/objects.d.ts:4606 |
|  `publisher_chat?` | [`TelegramChat`](TelegramChat.md) | *Optional*. Information about the chat that published the gift | @gramio/types/out/objects.d.ts:4622 |
|  `remaining_count?` | `number` | *Optional*. The number of remaining gifts of this type that can be sent by all users; for limited gifts only | @gramio/types/out/objects.d.ts:4602 |
|  `star_count` | `number` | The number of Telegram Stars that must be paid to send the sticker | @gramio/types/out/objects.d.ts:4582 |
|  `sticker` | [`TelegramSticker`](TelegramSticker.md) | The sticker that represents the gift | @gramio/types/out/objects.d.ts:4578 |
|  `total_count?` | `number` | *Optional*. The total number of gifts of this type that can be sent by all users; for limited gifts only | @gramio/types/out/objects.d.ts:4598 |
|  `unique_gift_variant_count?` | `number` | *Optional*. The total number of different unique gifts that can be obtained by upgrading the gift | @gramio/types/out/objects.d.ts:4618 |
|  `upgrade_star_count?` | `number` | *Optional*. The number of Telegram Stars that must be paid to upgrade the gift to a unique one | @gramio/types/out/objects.d.ts:4586 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramGiftBackground.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramGiftBackground

# Interface: TelegramGiftBackground

Defined in: @gramio/types/out/objects.d.ts:4550

This object describes the background of a gift.

[Documentation](https://core.telegram.org/bots/api/#giftbackground)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `center_color` | `number` | Center color of the background in RGB format | @gramio/types/out/objects.d.ts:4554 |
|  `edge_color` | `number` | Edge color of the background in RGB format | @gramio/types/out/objects.d.ts:4558 |
|  `text_color` | `number` | Text color of the background in RGB format | @gramio/types/out/objects.d.ts:4562 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramGiftInfo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramGiftInfo

# Interface: TelegramGiftInfo

Defined in: @gramio/types/out/objects.d.ts:4824

Describes a service message about a regular gift that was sent or received.

[Documentation](https://core.telegram.org/bots/api/#giftinfo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `can_be_upgraded?` | `true` | *Optional*. *True*, if the gift can be upgraded to a unique gift | @gramio/types/out/objects.d.ts:4848 |
|  `convert_star_count?` | `number` | *Optional*. Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible | @gramio/types/out/objects.d.ts:4836 |
|  `entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. Special entities that appear in the text | @gramio/types/out/objects.d.ts:4856 |
|  `gift` | [`TelegramGift`](TelegramGift.md) | Information about the gift | @gramio/types/out/objects.d.ts:4828 |
|  `is_private?` | `true` | *Optional*. *True*, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them | @gramio/types/out/objects.d.ts:4860 |
|  `is_upgrade_separate?` | `true` | *Optional*. *True*, if the gift's upgrade was purchased after the gift was sent | @gramio/types/out/objects.d.ts:4844 |
|  `owned_gift_id?` | `string` | *Optional*. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts | @gramio/types/out/objects.d.ts:4832 |
|  `prepaid_upgrade_star_count?` | `number` | *Optional*. Number of Telegram Stars that were prepaid for the ability to upgrade the gift | @gramio/types/out/objects.d.ts:4840 |
|  `text?` | `string` | *Optional*. Text of the message that was added to the gift | @gramio/types/out/objects.d.ts:4852 |
|  `unique_gift_number?` | `number` | *Optional*. Unique number reserved for this gift when upgraded. See the *number* field in [UniqueGift](https://core.telegram.org/bots/api#uniquegift) | @gramio/types/out/objects.d.ts:4864 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramGifts.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramGifts

# Interface: TelegramGifts

Defined in: @gramio/types/out/objects.d.ts:4630

This object represent a list of gifts.

[Documentation](https://core.telegram.org/bots/api/#gifts)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `gifts` | [`TelegramGift`](TelegramGift.md)\[] | The list of gifts | @gramio/types/out/objects.d.ts:4634 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramGiveaway.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramGiveaway

# Interface: TelegramGiveaway

Defined in: @gramio/types/out/objects.d.ts:2715

This object represents a message about a scheduled giveaway.

[Documentation](https://core.telegram.org/bots/api/#giveaway)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chats` | [`TelegramChat`](TelegramChat.md)\[] | The list of chats which the user must join to participate in the giveaway | @gramio/types/out/objects.d.ts:2719 |
|  `country_codes?` | `string`\[] | *Optional*. A list of two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways. | @gramio/types/out/objects.d.ts:2743 |
|  `has_public_winners?` | `true` | *Optional*. *True*, if the list of giveaway winners will be visible to everyone | @gramio/types/out/objects.d.ts:2735 |
|  `only_new_members?` | `true` | *Optional*. *True*, if only users who join the chats after the giveaway started should be eligible to win | @gramio/types/out/objects.d.ts:2731 |
|  `premium_subscription_month_count?` | `number` | *Optional*. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only | @gramio/types/out/objects.d.ts:2751 |
|  `prize_description?` | `string` | *Optional*. Description of additional giveaway prize | @gramio/types/out/objects.d.ts:2739 |
|  `prize_star_count?` | `number` | *Optional*. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | @gramio/types/out/objects.d.ts:2747 |
|  `winner_count` | `number` | The number of users which are supposed to be selected as winners of the giveaway | @gramio/types/out/objects.d.ts:2727 |
|  `winners_selection_date` | `number` | Point in time (Unix timestamp) when winners of the giveaway will be selected | @gramio/types/out/objects.d.ts:2723 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramGiveawayCompleted.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramGiveawayCompleted

# Interface: TelegramGiveawayCompleted

Defined in: @gramio/types/out/objects.d.ts:2815

This object represents a service message about the completion of a giveaway without public winners.

[Documentation](https://core.telegram.org/bots/api/#giveawaycompleted)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `giveaway_message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. Message with the giveaway that was completed, if it wasn't deleted | @gramio/types/out/objects.d.ts:2827 |
|  `is_star_giveaway?` | `true` | *Optional*. *True*, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway. | @gramio/types/out/objects.d.ts:2831 |
|  `unclaimed_prize_count?` | `number` | *Optional*. Number of undistributed prizes | @gramio/types/out/objects.d.ts:2823 |
|  `winner_count` | `number` | Number of winners in the giveaway | @gramio/types/out/objects.d.ts:2819 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramGiveawayCreated.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramGiveawayCreated

# Interface: TelegramGiveawayCreated

Defined in: @gramio/types/out/objects.d.ts:2703

This object represents a service message about the creation of a scheduled giveaway.

[Documentation](https://core.telegram.org/bots/api/#giveawaycreated)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `prize_star_count?` | `number` | *Optional*. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | @gramio/types/out/objects.d.ts:2707 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramGiveawayWinners.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramGiveawayWinners

# Interface: TelegramGiveawayWinners

Defined in: @gramio/types/out/objects.d.ts:2759

This object represents a message about the completion of a giveaway with public winners.

[Documentation](https://core.telegram.org/bots/api/#giveawaywinners)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `additional_chat_count?` | `number` | *Optional*. The number of other chats the user had to join in order to be eligible for the giveaway | @gramio/types/out/objects.d.ts:2783 |
|  `chat` | [`TelegramChat`](TelegramChat.md) | The chat that created the giveaway | @gramio/types/out/objects.d.ts:2763 |
|  `giveaway_message_id` | `number` | Identifier of the message with the giveaway in the chat | @gramio/types/out/objects.d.ts:2767 |
|  `only_new_members?` | `true` | *Optional*. *True*, if only users who had joined the chats after the giveaway started were eligible to win | @gramio/types/out/objects.d.ts:2799 |
|  `premium_subscription_month_count?` | `number` | *Optional*. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only | @gramio/types/out/objects.d.ts:2791 |
|  `prize_description?` | `string` | *Optional*. Description of additional giveaway prize | @gramio/types/out/objects.d.ts:2807 |
|  `prize_star_count?` | `number` | *Optional*. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only | @gramio/types/out/objects.d.ts:2787 |
|  `unclaimed_prize_count?` | `number` | *Optional*. Number of undistributed prizes | @gramio/types/out/objects.d.ts:2795 |
|  `was_refunded?` | `true` | *Optional*. *True*, if the giveaway was canceled because the payment for it was refunded | @gramio/types/out/objects.d.ts:2803 |
|  `winner_count` | `number` | Total number of winners in the giveaway | @gramio/types/out/objects.d.ts:2775 |
|  `winners` | [`TelegramUser`](TelegramUser.md)\[] | List of up to 100 winners of the giveaway | @gramio/types/out/objects.d.ts:2779 |
|  `winners_selection_date` | `number` | Point in time (Unix timestamp) when winners of the giveaway were selected | @gramio/types/out/objects.d.ts:2771 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInaccessibleMessage.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInaccessibleMessage

# Interface: TelegramInaccessibleMessage

Defined in: @gramio/types/out/objects.d.ts:947

This object describes a message that was deleted or is otherwise inaccessible to the bot.

[Documentation](https://core.telegram.org/bots/api/#inaccessiblemessage)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat` | [`TelegramChat`](TelegramChat.md) | Chat the message belonged to | @gramio/types/out/objects.d.ts:951 |
|  `date` | `number` | Always 0. The field can be used to differentiate regular and inaccessible messages. | @gramio/types/out/objects.d.ts:959 |
|  `message_id` | `number` | Unique message identifier inside the chat | @gramio/types/out/objects.d.ts:955 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineKeyboardButton.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineKeyboardButton

# Interface: TelegramInlineKeyboardButton

Defined in: @gramio/types/out/objects.d.ts:3221

This object represents one button of an inline keyboard. Exactly one of the fields other than *text*, *icon\_custom\_emoji\_id*, and *style* must be used to specify the type of the button.

[Documentation](https://core.telegram.org/bots/api/#inlinekeyboardbutton)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `callback_data?` | `string` | *Optional*. Data to be sent in a [callback query](https://core.telegram.org/bots/api#callbackquery) to the bot when the button is pressed, 1-64 bytes | @gramio/types/out/objects.d.ts:3241 |
|  `callback_game?` | [`TelegramCallbackGame`](TelegramCallbackGame.md) | *Optional*. Description of the game that will be launched when the user presses the button. **NOTE:** This type of button **must** always be the first button in the first row. | @gramio/types/out/objects.d.ts:3273 |
|  `copy_text?` | [`TelegramCopyTextButton`](TelegramCopyTextButton.md) | *Optional*. Description of the button that copies the specified text to the clipboard. | @gramio/types/out/objects.d.ts:3267 |
|  `icon_custom_emoji_id?` | `string` | *Optional*. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on [Fragment](https://fragment.com) or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription. | @gramio/types/out/objects.d.ts:3229 |
|  `login_url?` | [`TelegramLoginUrl`](TelegramLoginUrl.md) | *Optional*. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the [Telegram Login Widget](https://core.telegram.org/widgets/login). | @gramio/types/out/objects.d.ts:3249 |
|  `pay?` | `boolean` | *Optional*. Specify *True*, to send a [Pay button](https://core.telegram.org/bots/api#payments). Substrings “![⭐](https://telegram.org/img/emoji/40/E2AD90.png)” and “XTR” in the buttons's text will be replaced with a Telegram Star icon. **NOTE:** This type of button **must** always be the first button in the first row and can only be used in invoice messages. | @gramio/types/out/objects.d.ts:3279 |
|  `style?` | [`TelegramInlineKeyboardButtonStyle`](../type-aliases/TelegramInlineKeyboardButtonStyle.md) | *Optional*. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used. | @gramio/types/out/objects.d.ts:3233 |
|  `switch_inline_query?` | `string` | *Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account. | @gramio/types/out/objects.d.ts:3253 |
|  `switch_inline_query_chosen_chat?` | [`TelegramSwitchInlineQueryChosenChat`](TelegramSwitchInlineQueryChosenChat.md) | *Optional*. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account. | @gramio/types/out/objects.d.ts:3263 |
|  `switch_inline_query_current_chat?` | `string` | *Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted. This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a Telegram Business account. | @gramio/types/out/objects.d.ts:3259 |
|  `text` | `string` | Label text on the button | @gramio/types/out/objects.d.ts:3225 |
|  `url?` | `string` | *Optional*. HTTP or tg:// URL to be opened when the button is pressed. Links `tg://user?id=<user_id>` can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings. | @gramio/types/out/objects.d.ts:3237 |
|  `web_app?` | [`TelegramWebAppInfo`](TelegramWebAppInfo.md) | *Optional*. Description of the [Web App](https://core.telegram.org/bots/webapps) that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method [answerWebAppQuery](https://core.telegram.org/bots/api#answerwebappquery). Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account. | @gramio/types/out/objects.d.ts:3245 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineKeyboardMarkup.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineKeyboardMarkup

# Interface: TelegramInlineKeyboardMarkup

Defined in: @gramio/types/out/objects.d.ts:3207

This object represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.

[Documentation](https://core.telegram.org/bots/api/#inlinekeyboardmarkup)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `inline_keyboard` | [`TelegramInlineKeyboardButton`](TelegramInlineKeyboardButton.md)\[]\[] | Array of button rows, each represented by an Array of [InlineKeyboardButton](https://core.telegram.org/bots/api#inlinekeyboardbutton) objects | @gramio/types/out/objects.d.ts:3211 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQuery.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQuery

# Interface: TelegramInlineQuery

Defined in: @gramio/types/out/objects.d.ts:6238

This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.

[Documentation](https://core.telegram.org/bots/api/#inlinequery)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_type?` | [`TelegramInlineQueryChatType`](../type-aliases/TelegramInlineQueryChatType.md) | *Optional*. Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat | @gramio/types/out/objects.d.ts:6258 |
|  `from` | [`TelegramUser`](TelegramUser.md) | Sender | @gramio/types/out/objects.d.ts:6246 |
|  `id` | `string` | Unique identifier for this query | @gramio/types/out/objects.d.ts:6242 |
|  `location?` | [`TelegramLocation`](TelegramLocation.md) | *Optional*. Sender location, only for bots that request user location | @gramio/types/out/objects.d.ts:6262 |
|  `offset` | `string` | Offset of the results to be returned, can be controlled by the bot | @gramio/types/out/objects.d.ts:6254 |
|  `query` | `string` | Text of the query (up to 256 characters) | @gramio/types/out/objects.d.ts:6250 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultArticle.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultArticle

# Interface: TelegramInlineQueryResultArticle

Defined in: @gramio/types/out/objects.d.ts:6340

Represents a link to an article or web page.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultarticle)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `description?` | `string` | *Optional*. Short description of the result | @gramio/types/out/objects.d.ts:6370 |
|  `id` | `string` | Unique identifier for this result, 1-64 Bytes | @gramio/types/out/objects.d.ts:6348 |
|  `input_message_content` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | Content of the message to be sent | @gramio/types/out/objects.d.ts:6356 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:6360 |
|  `thumbnail_height?` | `number` | *Optional*. Thumbnail height | @gramio/types/out/objects.d.ts:6382 |
|  `thumbnail_url?` | `string` | *Optional*. Url of the thumbnail for the result | @gramio/types/out/objects.d.ts:6374 |
|  `thumbnail_width?` | `number` | *Optional*. Thumbnail width | @gramio/types/out/objects.d.ts:6378 |
|  `title` | `string` | Title of the result | @gramio/types/out/objects.d.ts:6352 |
|  `type` | `"article"` | Type of the result, must be *article* | @gramio/types/out/objects.d.ts:6344 |
|  `url?` | `string` | *Optional*. URL of the result | @gramio/types/out/objects.d.ts:6366 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultAudio.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultAudio

# Interface: TelegramInlineQueryResultAudio

Defined in: @gramio/types/out/objects.d.ts:6684

Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the audio.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultaudio)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `audio_duration?` | `number` | *Optional*. Audio duration in seconds | @gramio/types/out/objects.d.ts:6720 |
|  `audio_url` | `string` | A valid URL for the audio file | @gramio/types/out/objects.d.ts:6696 |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:6704 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:6712 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:6692 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the audio | @gramio/types/out/objects.d.ts:6730 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the audio caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:6708 |
|  `performer?` | `string` | *Optional*. Performer | @gramio/types/out/objects.d.ts:6716 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:6724 |
|  `title` | `string` | Title | @gramio/types/out/objects.d.ts:6700 |
|  `type` | `"audio"` | Type of the result, must be *audio* | @gramio/types/out/objects.d.ts:6688 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultCachedAudio.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultCachedAudio

# Interface: TelegramInlineQueryResultCachedAudio

Defined in: @gramio/types/out/objects.d.ts:7408

Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the audio.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultcachedaudio)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `audio_file_id` | `string` | A valid file identifier for the audio file | @gramio/types/out/objects.d.ts:7420 |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:7424 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:7432 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:7416 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the audio | @gramio/types/out/objects.d.ts:7442 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the audio caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:7428 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:7436 |
|  `type` | `"audio"` | Type of the result, must be *audio* | @gramio/types/out/objects.d.ts:7412 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultCachedDocument.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultCachedDocument

# Interface: TelegramInlineQueryResultCachedDocument

Defined in: @gramio/types/out/objects.d.ts:7258

Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the file.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultcacheddocument)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the document to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:7282 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:7290 |
|  `description?` | `string` | *Optional*. Short description of the result | @gramio/types/out/objects.d.ts:7278 |
|  `document_file_id` | `string` | A valid file identifier for the file | @gramio/types/out/objects.d.ts:7274 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:7266 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the file | @gramio/types/out/objects.d.ts:7300 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the document caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:7286 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:7294 |
|  `title` | `string` | Title for the result | @gramio/types/out/objects.d.ts:7270 |
|  `type` | `"document"` | Type of the result, must be *document* | @gramio/types/out/objects.d.ts:7262 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultCachedGif.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultCachedGif

# Interface: TelegramInlineQueryResultCachedGif

Defined in: @gramio/types/out/objects.d.ts:7128

Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with specified content instead of the animation.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultcachedgif)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the GIF file to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:7148 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:7156 |
|  `gif_file_id` | `string` | A valid file identifier for the GIF file | @gramio/types/out/objects.d.ts:7140 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:7136 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the GIF animation | @gramio/types/out/objects.d.ts:7170 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:7152 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:7164 |
|  `show_caption_above_media?` | `boolean` | *Optional*. Pass *True*, if the caption must be shown above the message media | @gramio/types/out/objects.d.ts:7160 |
|  `title?` | `string` | *Optional*. Title for the result | @gramio/types/out/objects.d.ts:7144 |
|  `type` | `"gif"` | Type of the result, must be *gif* | @gramio/types/out/objects.d.ts:7132 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultCachedMpeg4Gif.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultCachedMpeg4Gif

# Interface: TelegramInlineQueryResultCachedMpeg4Gif

Defined in: @gramio/types/out/objects.d.ts:7178

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the animation.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultcachedmpeg4gif)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:7198 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:7206 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:7186 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the video animation | @gramio/types/out/objects.d.ts:7220 |
|  `mpeg4_file_id` | `string` | A valid file identifier for the MPEG4 file | @gramio/types/out/objects.d.ts:7190 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:7202 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:7214 |
|  `show_caption_above_media?` | `boolean` | *Optional*. Pass *True*, if the caption must be shown above the message media | @gramio/types/out/objects.d.ts:7210 |
|  `title?` | `string` | *Optional*. Title for the result | @gramio/types/out/objects.d.ts:7194 |
|  `type` | `"mpeg4_gif"` | Type of the result, must be *mpeg4\_gif* | @gramio/types/out/objects.d.ts:7182 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultCachedPhoto.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultCachedPhoto

# Interface: TelegramInlineQueryResultCachedPhoto

Defined in: @gramio/types/out/objects.d.ts:7074

Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the photo.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultcachedphoto)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the photo to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:7098 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:7106 |
|  `description?` | `string` | *Optional*. Short description of the result | @gramio/types/out/objects.d.ts:7094 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:7082 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the photo | @gramio/types/out/objects.d.ts:7120 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the photo caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:7102 |
|  `photo_file_id` | `string` | A valid file identifier of the photo | @gramio/types/out/objects.d.ts:7086 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:7114 |
|  `show_caption_above_media?` | `boolean` | *Optional*. Pass *True*, if the caption must be shown above the message media | @gramio/types/out/objects.d.ts:7110 |
|  `title?` | `string` | *Optional*. Title for the result | @gramio/types/out/objects.d.ts:7090 |
|  `type` | `"photo"` | Type of the result, must be *photo* | @gramio/types/out/objects.d.ts:7078 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultCachedSticker.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultCachedSticker

# Interface: TelegramInlineQueryResultCachedSticker

Defined in: @gramio/types/out/objects.d.ts:7228

Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the sticker.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultcachedsticker)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:7236 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the sticker | @gramio/types/out/objects.d.ts:7250 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:7244 |
|  `sticker_file_id` | `string` | A valid file identifier of the sticker | @gramio/types/out/objects.d.ts:7240 |
|  `type` | `"sticker"` | Type of the result, must be *sticker* | @gramio/types/out/objects.d.ts:7232 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultCachedVideo.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultCachedVideo

# Interface: TelegramInlineQueryResultCachedVideo

Defined in: @gramio/types/out/objects.d.ts:7308

Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the video.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultcachedvideo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the video to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:7332 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:7340 |
|  `description?` | `string` | *Optional*. Short description of the result | @gramio/types/out/objects.d.ts:7328 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:7316 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the video | @gramio/types/out/objects.d.ts:7354 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the video caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:7336 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:7348 |
|  `show_caption_above_media?` | `boolean` | *Optional*. Pass *True*, if the caption must be shown above the message media | @gramio/types/out/objects.d.ts:7344 |
|  `title` | `string` | Title for the result | @gramio/types/out/objects.d.ts:7324 |
|  `type` | `"video"` | Type of the result, must be *video* | @gramio/types/out/objects.d.ts:7312 |
|  `video_file_id` | `string` | A valid file identifier for the video file | @gramio/types/out/objects.d.ts:7320 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultCachedVoice.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultCachedVoice

# Interface: TelegramInlineQueryResultCachedVoice

Defined in: @gramio/types/out/objects.d.ts:7362

Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the voice message.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultcachedvoice)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:7382 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:7390 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:7370 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the voice message | @gramio/types/out/objects.d.ts:7400 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the voice message caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:7386 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:7394 |
|  `title` | `string` | Voice message title | @gramio/types/out/objects.d.ts:7378 |
|  `type` | `"voice"` | Type of the result, must be *voice* | @gramio/types/out/objects.d.ts:7366 |
|  `voice_file_id` | `string` | A valid file identifier for the voice message | @gramio/types/out/objects.d.ts:7374 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultContact.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultContact

# Interface: TelegramInlineQueryResultContact

Defined in: @gramio/types/out/objects.d.ts:6994

Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the contact.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultcontact)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `first_name` | `string` | Contact's first name | @gramio/types/out/objects.d.ts:7010 |
|  `id` | `string` | Unique identifier for this result, 1-64 Bytes | @gramio/types/out/objects.d.ts:7002 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the contact | @gramio/types/out/objects.d.ts:7028 |
|  `last_name?` | `string` | *Optional*. Contact's last name | @gramio/types/out/objects.d.ts:7014 |
|  `phone_number` | `string` | Contact's phone number | @gramio/types/out/objects.d.ts:7006 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:7022 |
|  `thumbnail_height?` | `number` | *Optional*. Thumbnail height | @gramio/types/out/objects.d.ts:7040 |
|  `thumbnail_url?` | `string` | *Optional*. Url of the thumbnail for the result | @gramio/types/out/objects.d.ts:7032 |
|  `thumbnail_width?` | `number` | *Optional*. Thumbnail width | @gramio/types/out/objects.d.ts:7036 |
|  `type` | `"contact"` | Type of the result, must be *contact* | @gramio/types/out/objects.d.ts:6998 |
|  `vcard?` | `string` | *Optional*. Additional data about the contact in the form of a [vCard](https://en.wikipedia.org/wiki/VCard), 0-2048 bytes | @gramio/types/out/objects.d.ts:7018 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultDocument.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultDocument

# Interface: TelegramInlineQueryResultDocument

Defined in: @gramio/types/out/objects.d.ts:6792

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the file. Currently, only **.PDF** and **.ZIP** files can be sent using this method.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultdocument)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the document to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:6808 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:6816 |
|  `description?` | `string` | *Optional*. Short description of the result | @gramio/types/out/objects.d.ts:6828 |
|  `document_url` | `string` | A valid URL for the file | @gramio/types/out/objects.d.ts:6820 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:6800 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the file | @gramio/types/out/objects.d.ts:6838 |
|  `mime_type` | [`TelegramInlineQueryResultDocumentMimeType`](../type-aliases/TelegramInlineQueryResultDocumentMimeType.md) | MIME type of the content of the file, either “application/pdf” or “application/zip” | @gramio/types/out/objects.d.ts:6824 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the document caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:6812 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:6832 |
|  `thumbnail_height?` | `number` | *Optional*. Thumbnail height | @gramio/types/out/objects.d.ts:6850 |
|  `thumbnail_url?` | `string` | *Optional*. URL of the thumbnail (JPEG only) for the file | @gramio/types/out/objects.d.ts:6842 |
|  `thumbnail_width?` | `number` | *Optional*. Thumbnail width | @gramio/types/out/objects.d.ts:6846 |
|  `title` | `string` | Title for the result | @gramio/types/out/objects.d.ts:6804 |
|  `type` | `"document"` | Type of the result, must be *document* | @gramio/types/out/objects.d.ts:6796 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultGame.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultGame

# Interface: TelegramInlineQueryResultGame

Defined in: @gramio/types/out/objects.d.ts:7048

Represents a [Game](https://core.telegram.org/bots/api#games).

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultgame)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `game_short_name` | `string` | Short name of the game | @gramio/types/out/objects.d.ts:7060 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:7056 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:7064 |
|  `type` | `"game"` | Type of the result, must be *game* | @gramio/types/out/objects.d.ts:7052 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultGif.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultGif

# Interface: TelegramInlineQueryResultGif

Defined in: @gramio/types/out/objects.d.ts:6461

Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the animation.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultgif)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the GIF file to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:6501 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:6509 |
|  `gif_duration?` | `number` | *Optional*. Duration of the GIF in seconds | @gramio/types/out/objects.d.ts:6485 |
|  `gif_height?` | `number` | *Optional*. Height of the GIF | @gramio/types/out/objects.d.ts:6481 |
|  `gif_url` | `string` | A valid URL for the GIF file | @gramio/types/out/objects.d.ts:6473 |
|  `gif_width?` | `number` | *Optional*. Width of the GIF | @gramio/types/out/objects.d.ts:6477 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:6469 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the GIF animation | @gramio/types/out/objects.d.ts:6523 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:6505 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:6517 |
|  `show_caption_above_media?` | `boolean` | *Optional*. Pass *True*, if the caption must be shown above the message media | @gramio/types/out/objects.d.ts:6513 |
|  `thumbnail_mime_type?` | [`TelegramInlineQueryResultGifThumbnailMimeType`](../type-aliases/TelegramInlineQueryResultGifThumbnailMimeType.md) | *Optional*. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” | @gramio/types/out/objects.d.ts:6493 |
|  `thumbnail_url` | `string` | URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result | @gramio/types/out/objects.d.ts:6489 |
|  `title?` | `string` | *Optional*. Title for the result | @gramio/types/out/objects.d.ts:6497 |
|  `type` | `"gif"` | Type of the result, must be *gif* | @gramio/types/out/objects.d.ts:6465 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultLocation.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultLocation

# Interface: TelegramInlineQueryResultLocation

Defined in: @gramio/types/out/objects.d.ts:6858

Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the location.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultlocation)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `heading?` | `number` | *Optional*. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | @gramio/types/out/objects.d.ts:6890 |
|  `horizontal_accuracy?` | `number` | *Optional*. The radius of uncertainty for the location, measured in meters; 0-1500 | @gramio/types/out/objects.d.ts:6882 |
|  `id` | `string` | Unique identifier for this result, 1-64 Bytes | @gramio/types/out/objects.d.ts:6866 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the location | @gramio/types/out/objects.d.ts:6904 |
|  `latitude` | `number` | Location latitude in degrees | @gramio/types/out/objects.d.ts:6870 |
|  `live_period?` | `number` | *Optional*. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. | @gramio/types/out/objects.d.ts:6886 |
|  `longitude` | `number` | Location longitude in degrees | @gramio/types/out/objects.d.ts:6874 |
|  `proximity_alert_radius?` | `number` | *Optional*. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | @gramio/types/out/objects.d.ts:6894 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:6898 |
|  `thumbnail_height?` | `number` | *Optional*. Thumbnail height | @gramio/types/out/objects.d.ts:6916 |
|  `thumbnail_url?` | `string` | *Optional*. Url of the thumbnail for the result | @gramio/types/out/objects.d.ts:6908 |
|  `thumbnail_width?` | `number` | *Optional*. Thumbnail width | @gramio/types/out/objects.d.ts:6912 |
|  `title` | `string` | Location title | @gramio/types/out/objects.d.ts:6878 |
|  `type` | `"location"` | Type of the result, must be *location* | @gramio/types/out/objects.d.ts:6862 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultMpeg4Gif.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultMpeg4Gif

# Interface: TelegramInlineQueryResultMpeg4Gif

Defined in: @gramio/types/out/objects.d.ts:6536

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the animation.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultmpeg4gif)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:6576 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:6584 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:6544 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the video animation | @gramio/types/out/objects.d.ts:6598 |
|  `mpeg4_duration?` | `number` | *Optional*. Video duration in seconds | @gramio/types/out/objects.d.ts:6560 |
|  `mpeg4_height?` | `number` | *Optional*. Video height | @gramio/types/out/objects.d.ts:6556 |
|  `mpeg4_url` | `string` | A valid URL for the MPEG4 file | @gramio/types/out/objects.d.ts:6548 |
|  `mpeg4_width?` | `number` | *Optional*. Video width | @gramio/types/out/objects.d.ts:6552 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:6580 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:6592 |
|  `show_caption_above_media?` | `boolean` | *Optional*. Pass *True*, if the caption must be shown above the message media | @gramio/types/out/objects.d.ts:6588 |
|  `thumbnail_mime_type?` | [`TelegramInlineQueryResultMpeg4GifThumbnailMimeType`](../type-aliases/TelegramInlineQueryResultMpeg4GifThumbnailMimeType.md) | *Optional*. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” | @gramio/types/out/objects.d.ts:6568 |
|  `thumbnail_url` | `string` | URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result | @gramio/types/out/objects.d.ts:6564 |
|  `title?` | `string` | *Optional*. Title for the result | @gramio/types/out/objects.d.ts:6572 |
|  `type` | `"mpeg4_gif"` | Type of the result, must be *mpeg4\_gif* | @gramio/types/out/objects.d.ts:6540 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultPhoto.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultPhoto

# Interface: TelegramInlineQueryResultPhoto

Defined in: @gramio/types/out/objects.d.ts:6390

Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the photo.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultphoto)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the photo to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:6426 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:6434 |
|  `description?` | `string` | *Optional*. Short description of the result | @gramio/types/out/objects.d.ts:6422 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:6398 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the photo | @gramio/types/out/objects.d.ts:6448 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the photo caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:6430 |
|  `photo_height?` | `number` | *Optional*. Height of the photo | @gramio/types/out/objects.d.ts:6414 |
|  `photo_url` | `string` | A valid URL of the photo. Photo must be in **JPEG** format. Photo size must not exceed 5MB | @gramio/types/out/objects.d.ts:6402 |
|  `photo_width?` | `number` | *Optional*. Width of the photo | @gramio/types/out/objects.d.ts:6410 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:6442 |
|  `show_caption_above_media?` | `boolean` | *Optional*. Pass *True*, if the caption must be shown above the message media | @gramio/types/out/objects.d.ts:6438 |
|  `thumbnail_url` | `string` | URL of the thumbnail for the photo | @gramio/types/out/objects.d.ts:6406 |
|  `title?` | `string` | *Optional*. Title for the result | @gramio/types/out/objects.d.ts:6418 |
|  `type` | `"photo"` | Type of the result, must be *photo* | @gramio/types/out/objects.d.ts:6394 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultsButton.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultsButton

# Interface: TelegramInlineQueryResultsButton

Defined in: @gramio/types/out/objects.d.ts:6270

This object represents a button to be shown above inline query results. You **must** use exactly one of the optional fields.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultsbutton)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `start_parameter?` | `string` | *Optional*. [Deep-linking](https://core.telegram.org/bots/features#deep-linking) parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only `A-Z`, `a-z`, `0-9`, `_` and `-` are allowed. *Example:* An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a [*switch\_inline*](https://core.telegram.org/bots/api#inlinekeyboardmarkup) button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities. | @gramio/types/out/objects.d.ts:6284 |
|  `text` | `string` | Label text on the button | @gramio/types/out/objects.d.ts:6274 |
|  `web_app?` | [`TelegramWebAppInfo`](TelegramWebAppInfo.md) | *Optional*. Description of the [Web App](https://core.telegram.org/bots/webapps) that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method [switchInlineQuery](https://core.telegram.org/bots/webapps#initializing-mini-apps) inside the Web App. | @gramio/types/out/objects.d.ts:6278 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultVenue.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultVenue

# Interface: TelegramInlineQueryResultVenue

Defined in: @gramio/types/out/objects.d.ts:6924

Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the venue.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultvenue)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `address` | `string` | Address of the venue | @gramio/types/out/objects.d.ts:6948 |
|  `foursquare_id?` | `string` | *Optional*. Foursquare identifier of the venue if known | @gramio/types/out/objects.d.ts:6952 |
|  `foursquare_type?` | `string` | *Optional*. Foursquare type of the venue, if known. (For example, “arts\_entertainment/default”, “arts\_entertainment/aquarium” or “food/icecream”.) | @gramio/types/out/objects.d.ts:6956 |
|  `google_place_id?` | `string` | *Optional*. Google Places identifier of the venue | @gramio/types/out/objects.d.ts:6960 |
|  `google_place_type?` | `string` | *Optional*. Google Places type of the venue. (See [supported types](https://developers.google.com/places/web-service/supported_types).) | @gramio/types/out/objects.d.ts:6964 |
|  `id` | `string` | Unique identifier for this result, 1-64 Bytes | @gramio/types/out/objects.d.ts:6932 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the venue | @gramio/types/out/objects.d.ts:6974 |
|  `latitude` | `number` | Latitude of the venue location in degrees | @gramio/types/out/objects.d.ts:6936 |
|  `longitude` | `number` | Longitude of the venue location in degrees | @gramio/types/out/objects.d.ts:6940 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:6968 |
|  `thumbnail_height?` | `number` | *Optional*. Thumbnail height | @gramio/types/out/objects.d.ts:6986 |
|  `thumbnail_url?` | `string` | *Optional*. Url of the thumbnail for the result | @gramio/types/out/objects.d.ts:6978 |
|  `thumbnail_width?` | `number` | *Optional*. Thumbnail width | @gramio/types/out/objects.d.ts:6982 |
|  `title` | `string` | Title of the venue | @gramio/types/out/objects.d.ts:6944 |
|  `type` | `"venue"` | Type of the result, must be *venue* | @gramio/types/out/objects.d.ts:6928 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultVideo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultVideo

# Interface: TelegramInlineQueryResultVideo

Defined in: @gramio/types/out/objects.d.ts:6610

Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the video.

> If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you **must** replace its content using *input\_message\_content*.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultvideo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the video to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:6638 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:6646 |
|  `description?` | `string` | *Optional*. Short description of the result | @gramio/types/out/objects.d.ts:6666 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:6618 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the video. This field is **required** if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video). | @gramio/types/out/objects.d.ts:6676 |
|  `mime_type` | [`TelegramInlineQueryResultVideoMimeType`](../type-aliases/TelegramInlineQueryResultVideoMimeType.md) | MIME type of the content of the video URL, “text/html” or “video/mp4” | @gramio/types/out/objects.d.ts:6626 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the video caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:6642 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:6670 |
|  `show_caption_above_media?` | `boolean` | *Optional*. Pass *True*, if the caption must be shown above the message media | @gramio/types/out/objects.d.ts:6650 |
|  `thumbnail_url` | `string` | URL of the thumbnail (JPEG only) for the video | @gramio/types/out/objects.d.ts:6630 |
|  `title` | `string` | Title for the result | @gramio/types/out/objects.d.ts:6634 |
|  `type` | `"video"` | Type of the result, must be *video* | @gramio/types/out/objects.d.ts:6614 |
|  `video_duration?` | `number` | *Optional*. Video duration in seconds | @gramio/types/out/objects.d.ts:6662 |
|  `video_height?` | `number` | *Optional*. Video height | @gramio/types/out/objects.d.ts:6658 |
|  `video_url` | `string` | A valid URL for the embedded video player or video file | @gramio/types/out/objects.d.ts:6622 |
|  `video_width?` | `number` | *Optional*. Video width | @gramio/types/out/objects.d.ts:6654 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInlineQueryResultVoice.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultVoice

# Interface: TelegramInlineQueryResultVoice

Defined in: @gramio/types/out/objects.d.ts:6738

Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use *input\_message\_content* to send a message with the specified content instead of the the voice message.

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresultvoice)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:6758 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:6766 |
|  `id` | `string` | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:6746 |
|  `input_message_content?` | [`TelegramInputMessageContent`](../type-aliases/TelegramInputMessageContent.md) | *Optional*. Content of the message to be sent instead of the voice recording | @gramio/types/out/objects.d.ts:6780 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the voice message caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:6762 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message | @gramio/types/out/objects.d.ts:6774 |
|  `title` | `string` | Recording title | @gramio/types/out/objects.d.ts:6754 |
|  `type` | `"voice"` | Type of the result, must be *voice* | @gramio/types/out/objects.d.ts:6742 |
|  `voice_duration?` | `number` | *Optional*. Recording duration in seconds | @gramio/types/out/objects.d.ts:6770 |
|  `voice_url` | `string` | A valid URL for the voice recording | @gramio/types/out/objects.d.ts:6750 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputChecklist.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputChecklist

# Interface: TelegramInputChecklist

Defined in: @gramio/types/out/objects.d.ts:1983

Describes a checklist to create.

[Documentation](https://core.telegram.org/bots/api/#inputchecklist)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `others_can_add_tasks?` | `boolean` | *Optional*. Pass *True* if other users can add tasks to the checklist | @gramio/types/out/objects.d.ts:2003 |
|  `others_can_mark_tasks_as_done?` | `boolean` | *Optional*. Pass *True* if other users can mark tasks as done or not done in the checklist | @gramio/types/out/objects.d.ts:2007 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the title. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:1991 |
|  `tasks` | [`TelegramInputChecklistTask`](TelegramInputChecklistTask.md)\[] | List of 1-30 tasks in the checklist | @gramio/types/out/objects.d.ts:1999 |
|  `title` | `string` | { `toString`: `string`; } | Title of the checklist; 1-255 characters after entities parsing | @gramio/types/out/objects.d.ts:1987 |
|  `title_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the title, which can be specified instead of parse\_mode. Currently, only *bold*, *italic*, *underline*, *strikethrough*, *spoiler*, and *custom\_emoji* entities are allowed. | @gramio/types/out/objects.d.ts:1995 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputChecklistTask.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputChecklistTask

# Interface: TelegramInputChecklistTask

Defined in: @gramio/types/out/objects.d.ts:1959

Describes a task to add to a checklist.

[Documentation](https://core.telegram.org/bots/api/#inputchecklisttask)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `id` | `number` | Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist | @gramio/types/out/objects.d.ts:1963 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the text. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:1971 |
|  `text` | `string` | { `toString`: `string`; } | Text of the task; 1-100 characters after entities parsing | @gramio/types/out/objects.d.ts:1967 |
|  `text_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the text, which can be specified instead of parse\_mode. Currently, only *bold*, *italic*, *underline*, *strikethrough*, *spoiler*, and *custom\_emoji* entities are allowed. | @gramio/types/out/objects.d.ts:1975 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputContactMessageContent.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputContactMessageContent

# Interface: TelegramInputContactMessageContent

Defined in: @gramio/types/out/objects.d.ts:7564

Represents the [content](https://core.telegram.org/bots/api#inputmessagecontent) of a contact message to be sent as the result of an inline query.

[Documentation](https://core.telegram.org/bots/api/#inputcontactmessagecontent)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `first_name` | `string` | Contact's first name | @gramio/types/out/objects.d.ts:7572 |
|  `last_name?` | `string` | *Optional*. Contact's last name | @gramio/types/out/objects.d.ts:7576 |
|  `phone_number` | `string` | Contact's phone number | @gramio/types/out/objects.d.ts:7568 |
|  `vcard?` | `string` | *Optional*. Additional data about the contact in the form of a [vCard](https://en.wikipedia.org/wiki/VCard), 0-2048 bytes | @gramio/types/out/objects.d.ts:7580 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputInvoiceMessageContent.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputInvoiceMessageContent

# Interface: TelegramInputInvoiceMessageContent

Defined in: @gramio/types/out/objects.d.ts:7588

Represents the [content](https://core.telegram.org/bots/api#inputmessagecontent) of an invoice message to be sent as the result of an inline query.

[Documentation](https://core.telegram.org/bots/api/#inputinvoicemessagecontent)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `currency` | [`TelegramCurrencies`](../type-aliases/TelegramCurrencies.md) | Three-letter ISO 4217 currency code, see [more on currencies](https://core.telegram.org/bots/payments#supported-currencies). Pass “XTR” for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/objects.d.ts:7608 |
|  `description` | `string` | Product description, 1-255 characters | @gramio/types/out/objects.d.ts:7596 |
|  `is_flexible?` | `boolean` | *Optional*. Pass *True* if the final price depends on the shipping method. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/objects.d.ts:7668 |
|  `max_tip_amount?` | `number` | *Optional*. The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of `US$ 1.45` pass `max_tip_amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/objects.d.ts:7616 |
|  `need_email?` | `boolean` | *Optional*. Pass *True* if you require the user's email address to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/objects.d.ts:7652 |
|  `need_name?` | `boolean` | *Optional*. Pass *True* if you require the user's full name to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/objects.d.ts:7644 |
|  `need_phone_number?` | `boolean` | *Optional*. Pass *True* if you require the user's phone number to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/objects.d.ts:7648 |
|  `need_shipping_address?` | `boolean` | *Optional*. Pass *True* if you require the user's shipping address to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/objects.d.ts:7656 |
|  `payload` | `string` | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. | @gramio/types/out/objects.d.ts:7600 |
|  `photo_height?` | `number` | *Optional*. Photo height | @gramio/types/out/objects.d.ts:7640 |
|  `photo_size?` | `number` | *Optional*. Photo size in bytes | @gramio/types/out/objects.d.ts:7632 |
|  `photo_url?` | `string` | *Optional*. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. | @gramio/types/out/objects.d.ts:7628 |
|  `photo_width?` | `number` | *Optional*. Photo width | @gramio/types/out/objects.d.ts:7636 |
|  `prices` | [`TelegramLabeledPrice`](TelegramLabeledPrice.md)\[] | Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/objects.d.ts:7612 |
|  `provider_data?` | `string` | *Optional*. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider. | @gramio/types/out/objects.d.ts:7624 |
|  `provider_token?` | `string` | *Optional*. Payment provider token, obtained via [@BotFather](https://t.me/botfather). Pass an empty string for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/objects.d.ts:7604 |
|  `send_email_to_provider?` | `boolean` | *Optional*. Pass *True* if the user's email address should be sent to the provider. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/objects.d.ts:7664 |
|  `send_phone_number_to_provider?` | `boolean` | *Optional*. Pass *True* if the user's phone number should be sent to the provider. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90). | @gramio/types/out/objects.d.ts:7660 |
|  `suggested_tip_amounts?` | `number`\[] | *Optional*. A JSON-serialized array of suggested amounts of tip in the *smallest units* of the currency (integer, **not** float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed *max\_tip\_amount*. | @gramio/types/out/objects.d.ts:7620 |
|  `title` | `string` | Product name, 1-32 characters | @gramio/types/out/objects.d.ts:7592 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramInputLocationMessageContent.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputLocationMessageContent

# Interface: TelegramInputLocationMessageContent

Defined in: @gramio/types/out/objects.d.ts:7492

Represents the [content](https://core.telegram.org/bots/api#inputmessagecontent) of a location message to be sent as the result of an inline query.

[Documentation](https://core.telegram.org/bots/api/#inputlocationmessagecontent)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `heading?` | `number` | *Optional*. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | @gramio/types/out/objects.d.ts:7512 |
|  `horizontal_accuracy?` | `number` | *Optional*. The radius of uncertainty for the location, measured in meters; 0-1500 | @gramio/types/out/objects.d.ts:7504 |
|  `latitude` | `number` | Latitude of the location in degrees | @gramio/types/out/objects.d.ts:7496 |
|  `live_period?` | `number` | *Optional*. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. | @gramio/types/out/objects.d.ts:7508 |
|  `longitude` | `number` | Longitude of the location in degrees | @gramio/types/out/objects.d.ts:7500 |
|  `proximity_alert_radius?` | `number` | *Optional*. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | @gramio/types/out/objects.d.ts:7516 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputMediaAnimation.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputMediaAnimation

# Interface: TelegramInputMediaAnimation

Defined in: @gramio/types/out/objects.d.ts:5760

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

[Documentation](https://core.telegram.org/bots/api/#inputmediaanimation)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the animation to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:5776 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:5784 |
|  `duration?` | `number` | *Optional*. Animation duration in seconds | @gramio/types/out/objects.d.ts:5800 |
|  `has_spoiler?` | `boolean` | *Optional*. Pass *True* if the animation needs to be covered with a spoiler animation | @gramio/types/out/objects.d.ts:5804 |
|  `height?` | `number` | *Optional*. Animation height | @gramio/types/out/objects.d.ts:5796 |
|  `media` | `string` | `Blob` | File to send. Pass a file\_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://\<file\_attach\_name>” to upload a new one using multipart/form-data under \<file\_attach\_name> name. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5768 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the animation caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:5780 |
|  `show_caption_above_media?` | `boolean` | *Optional*. Pass *True*, if the caption must be shown above the message media | @gramio/types/out/objects.d.ts:5788 |
|  `thumbnail?` | `string` | `Blob` | *Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the thumbnail was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5772 |
|  `type` | `"animation"` | Type of the result, must be *animation* | @gramio/types/out/objects.d.ts:5764 |
|  `width?` | `number` | *Optional*. Animation width | @gramio/types/out/objects.d.ts:5792 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputMediaAudio.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputMediaAudio

# Interface: TelegramInputMediaAudio

Defined in: @gramio/types/out/objects.d.ts:5812

Represents an audio file to be treated as music to be sent.

[Documentation](https://core.telegram.org/bots/api/#inputmediaaudio)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the audio to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:5828 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:5836 |
|  `duration?` | `number` | *Optional*. Duration of the audio in seconds | @gramio/types/out/objects.d.ts:5840 |
|  `media` | `string` | `Blob` | File to send. Pass a file\_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://\<file\_attach\_name>” to upload a new one using multipart/form-data under \<file\_attach\_name> name. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5820 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the audio caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:5832 |
|  `performer?` | `string` | *Optional*. Performer of the audio | @gramio/types/out/objects.d.ts:5844 |
|  `thumbnail?` | `string` | `Blob` | *Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the thumbnail was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5824 |
|  `title?` | `string` | *Optional*. Title of the audio | @gramio/types/out/objects.d.ts:5848 |
|  `type` | `"audio"` | Type of the result, must be *audio* | @gramio/types/out/objects.d.ts:5816 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputMediaDocument.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputMediaDocument

# Interface: TelegramInputMediaDocument

Defined in: @gramio/types/out/objects.d.ts:5856

Represents a general file to be sent.

[Documentation](https://core.telegram.org/bots/api/#inputmediadocument)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the document to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:5872 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:5880 |
|  `disable_content_type_detection?` | `boolean` | *Optional*. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always *True*, if the document is sent as part of an album. | @gramio/types/out/objects.d.ts:5884 |
|  `media` | `string` | `Blob` | File to send. Pass a file\_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://\<file\_attach\_name>” to upload a new one using multipart/form-data under \<file\_attach\_name> name. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5864 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the document caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:5876 |
|  `thumbnail?` | `string` | `Blob` | *Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the thumbnail was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5868 |
|  `type` | `"document"` | Type of the result, must be *document* | @gramio/types/out/objects.d.ts:5860 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputMediaPhoto.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputMediaPhoto

# Interface: TelegramInputMediaPhoto

Defined in: @gramio/types/out/objects.d.ts:5660

Represents a photo to be sent.

[Documentation](https://core.telegram.org/bots/api/#inputmediaphoto)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the photo to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:5672 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:5680 |
|  `has_spoiler?` | `boolean` | *Optional*. Pass *True* if the photo needs to be covered with a spoiler animation | @gramio/types/out/objects.d.ts:5688 |
|  `media` | `string` | `Blob` | File to send. Pass a file\_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://\<file\_attach\_name>” to upload a new one using multipart/form-data under \<file\_attach\_name> name. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5668 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the photo caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:5676 |
|  `show_caption_above_media?` | `boolean` | *Optional*. Pass *True*, if the caption must be shown above the message media | @gramio/types/out/objects.d.ts:5684 |
|  `type` | `"photo"` | Type of the result, must be *photo* | @gramio/types/out/objects.d.ts:5664 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputMediaVideo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputMediaVideo

# Interface: TelegramInputMediaVideo

Defined in: @gramio/types/out/objects.d.ts:5696

Represents a video to be sent.

[Documentation](https://core.telegram.org/bots/api/#inputmediavideo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `caption?` | `string` | { `toString`: `string`; } | *Optional*. Caption of the video to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:5720 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in the caption, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:5728 |
|  `cover?` | `string` | `Blob` | *Optional*. Cover for the video in the message. Pass a file\_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://\<file\_attach\_name>” to upload a new one using multipart/form-data under \<file\_attach\_name> name. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5712 |
|  `duration?` | `number` | *Optional*. Video duration in seconds | @gramio/types/out/objects.d.ts:5744 |
|  `has_spoiler?` | `boolean` | *Optional*. Pass *True* if the video needs to be covered with a spoiler animation | @gramio/types/out/objects.d.ts:5752 |
|  `height?` | `number` | *Optional*. Video height | @gramio/types/out/objects.d.ts:5740 |
|  `media` | `string` | `Blob` | File to send. Pass a file\_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://\<file\_attach\_name>” to upload a new one using multipart/form-data under \<file\_attach\_name> name. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5704 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the video caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:5724 |
|  `show_caption_above_media?` | `boolean` | *Optional*. Pass *True*, if the caption must be shown above the message media | @gramio/types/out/objects.d.ts:5732 |
|  `start_timestamp?` | `number` | *Optional*. Start timestamp for the video in the message | @gramio/types/out/objects.d.ts:5716 |
|  `supports_streaming?` | `boolean` | *Optional*. Pass *True* if the uploaded video is suitable for streaming | @gramio/types/out/objects.d.ts:5748 |
|  `thumbnail?` | `string` | `Blob` | *Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the thumbnail was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5708 |
|  `type` | `"video"` | Type of the result, must be *video* | @gramio/types/out/objects.d.ts:5700 |
|  `width?` | `number` | *Optional*. Video width | @gramio/types/out/objects.d.ts:5736 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputPaidMediaPhoto.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputPaidMediaPhoto

# Interface: TelegramInputPaidMediaPhoto

Defined in: @gramio/types/out/objects.d.ts:5911

The paid media to send is a photo.

[Documentation](https://core.telegram.org/bots/api/#inputpaidmediaphoto)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `media` | `string` | `Blob` | File to send. Pass a file\_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://\<file\_attach\_name>” to upload a new one using multipart/form-data under \<file\_attach\_name> name. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5919 |
|  `type` | `"photo"` | Type of the media, must be *photo* | @gramio/types/out/objects.d.ts:5915 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputPaidMediaVideo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputPaidMediaVideo

# Interface: TelegramInputPaidMediaVideo

Defined in: @gramio/types/out/objects.d.ts:5927

The paid media to send is a video.

[Documentation](https://core.telegram.org/bots/api/#inputpaidmediavideo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `cover?` | `string` | `Blob` | *Optional*. Cover for the video in the message. Pass a file\_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://\<file\_attach\_name>” to upload a new one using multipart/form-data under \<file\_attach\_name> name. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5943 |
|  `duration?` | `number` | *Optional*. Video duration in seconds | @gramio/types/out/objects.d.ts:5959 |
|  `height?` | `number` | *Optional*. Video height | @gramio/types/out/objects.d.ts:5955 |
|  `media` | `string` | `Blob` | File to send. Pass a file\_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://\<file\_attach\_name>” to upload a new one using multipart/form-data under \<file\_attach\_name> name. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5935 |
|  `start_timestamp?` | `number` | *Optional*. Start timestamp for the video in the message | @gramio/types/out/objects.d.ts:5947 |
|  `supports_streaming?` | `boolean` | *Optional*. Pass *True* if the uploaded video is suitable for streaming | @gramio/types/out/objects.d.ts:5963 |
|  `thumbnail?` | `string` | `Blob` | *Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the thumbnail was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5939 |
|  `type` | `"video"` | Type of the media, must be *video* | @gramio/types/out/objects.d.ts:5931 |
|  `width?` | `number` | *Optional*. Video width | @gramio/types/out/objects.d.ts:5951 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputPollOption.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputPollOption

# Interface: TelegramInputPollOption

Defined in: @gramio/types/out/objects.d.ts:1789

This object contains information about one answer option in a poll to be sent.

[Documentation](https://core.telegram.org/bots/api/#inputpolloption)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `text` | `string` | { `toString`: `string`; } | Option text, 1-100 characters | @gramio/types/out/objects.d.ts:1793 |
|  `text_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of *text\_parse\_mode* | @gramio/types/out/objects.d.ts:1801 |
|  `text_parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the text. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. Currently, only custom emoji entities are allowed | @gramio/types/out/objects.d.ts:1797 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputProfilePhotoAnimated.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputProfilePhotoAnimated

# Interface: TelegramInputProfilePhotoAnimated

Defined in: @gramio/types/out/objects.d.ts:5999

An animated profile photo in the MPEG4 format.

[Documentation](https://core.telegram.org/bots/api/#inputprofilephotoanimated)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `animation` | `string` | `Blob` | The animated profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the photo was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:6007 |
|  `main_frame_timestamp?` | `number` | *Optional*. Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0. | @gramio/types/out/objects.d.ts:6011 |
|  `type` | `"animated"` | Type of the profile photo, must be *animated* | @gramio/types/out/objects.d.ts:6003 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputProfilePhotoStatic.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputProfilePhotoStatic

# Interface: TelegramInputProfilePhotoStatic

Defined in: @gramio/types/out/objects.d.ts:5983

A static profile photo in the .JPG format.

[Documentation](https://core.telegram.org/bots/api/#inputprofilephotostatic)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `photo` | `string` | `Blob` | The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the photo was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:5991 |
|  `type` | `"static"` | Type of the profile photo, must be *static* | @gramio/types/out/objects.d.ts:5987 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputSticker.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputSticker

# Interface: TelegramInputSticker

Defined in: @gramio/types/out/objects.d.ts:6203

This object describes a sticker to be added to a sticker set.

[Documentation](https://core.telegram.org/bots/api/#inputsticker)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `emoji_list` | `string`\[] | List of 1-20 emoji associated with the sticker | @gramio/types/out/objects.d.ts:6215 |
|  `format` | [`TelegramInputStickerFormat`](../type-aliases/TelegramInputStickerFormat.md) | Format of the added sticker, must be one of “static” for a **.WEBP** or **.PNG** image, “animated” for a **.TGS** animation, “video” for a **.WEBM** video | @gramio/types/out/objects.d.ts:6211 |
|  `keywords?` | `string`\[] | *Optional*. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom\_emoji” stickers only. | @gramio/types/out/objects.d.ts:6223 |
|  `mask_position?` | [`TelegramMaskPosition`](TelegramMaskPosition.md) | *Optional*. Position where the mask should be placed on faces. For “mask” stickers only. | @gramio/types/out/objects.d.ts:6219 |
|  `sticker` | `string` | `Blob` | The added sticker. Pass a *file\_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or pass “attach://\<file\_attach\_name>” to upload a new file using multipart/form-data under \<file\_attach\_name> name. Animated and video stickers can't be uploaded via HTTP URL. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:6207 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputStoryContentPhoto.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputStoryContentPhoto

# Interface: TelegramInputStoryContentPhoto

Defined in: @gramio/types/out/objects.d.ts:6031

Describes a photo to post as a story.

[Documentation](https://core.telegram.org/bots/api/#inputstorycontentphoto)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `photo` | `string` | `Blob` | The photo to post as a story. The photo must be of the size 1080x1920 and must not exceed 10 MB. The photo can't be reused and can only be uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the photo was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:6039 |
|  `type` | `"photo"` | Type of the content, must be *photo* | @gramio/types/out/objects.d.ts:6035 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputStoryContentVideo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputStoryContentVideo

# Interface: TelegramInputStoryContentVideo

Defined in: @gramio/types/out/objects.d.ts:6047

Describes a video to post as a story.

[Documentation](https://core.telegram.org/bots/api/#inputstorycontentvideo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `cover_frame_timestamp?` | `number` | *Optional*. Timestamp in seconds of the frame that will be used as the static cover for the story. Defaults to 0.0. | @gramio/types/out/objects.d.ts:6063 |
|  `duration?` | `number` | *Optional*. Precise duration of the video in seconds; 0-60 | @gramio/types/out/objects.d.ts:6059 |
|  `is_animation?` | `boolean` | *Optional*. Pass *True* if the video has no sound | @gramio/types/out/objects.d.ts:6067 |
|  `type` | `"video"` | Type of the content, must be *video* | @gramio/types/out/objects.d.ts:6051 |
|  `video` | `string` | `Blob` | The video to post as a story. The video must be of the size 720x1280, streamable, encoded with H.265 codec, with key frames added each second in the MPEG4 format, and must not exceed 30 MB. The video can't be reused and can only be uploaded as a new file, so you can pass “attach://\<file\_attach\_name>” if the video was uploaded using multipart/form-data under \<file\_attach\_name>. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/objects.d.ts:6055 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputTextMessageContent.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputTextMessageContent

# Interface: TelegramInputTextMessageContent

Defined in: @gramio/types/out/objects.d.ts:7468

Represents the [content](https://core.telegram.org/bots/api#inputmessagecontent) of a text message to be sent as the result of an inline query.

[Documentation](https://core.telegram.org/bots/api/#inputtextmessagecontent)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. List of special entities that appear in message text, which can be specified instead of *parse\_mode* | @gramio/types/out/objects.d.ts:7480 |
|  `link_preview_options?` | [`TelegramLinkPreviewOptions`](TelegramLinkPreviewOptions.md) | *Optional*. Link preview generation options for the message | @gramio/types/out/objects.d.ts:7484 |
|  `message_text` | `string` | Text of the message to be sent, 1-4096 characters | @gramio/types/out/objects.d.ts:7472 |
|  `parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the message text. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:7476 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInputVenueMessageContent.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputVenueMessageContent

# Interface: TelegramInputVenueMessageContent

Defined in: @gramio/types/out/objects.d.ts:7524

Represents the [content](https://core.telegram.org/bots/api#inputmessagecontent) of a venue message to be sent as the result of an inline query.

[Documentation](https://core.telegram.org/bots/api/#inputvenuemessagecontent)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `address` | `string` | Address of the venue | @gramio/types/out/objects.d.ts:7540 |
|  `foursquare_id?` | `string` | *Optional*. Foursquare identifier of the venue, if known | @gramio/types/out/objects.d.ts:7544 |
|  `foursquare_type?` | `string` | *Optional*. Foursquare type of the venue, if known. (For example, “arts\_entertainment/default”, “arts\_entertainment/aquarium” or “food/icecream”.) | @gramio/types/out/objects.d.ts:7548 |
|  `google_place_id?` | `string` | *Optional*. Google Places identifier of the venue | @gramio/types/out/objects.d.ts:7552 |
|  `google_place_type?` | `string` | *Optional*. Google Places type of the venue. (See [supported types](https://developers.google.com/places/web-service/supported_types).) | @gramio/types/out/objects.d.ts:7556 |
|  `latitude` | `number` | Latitude of the venue in degrees | @gramio/types/out/objects.d.ts:7528 |
|  `longitude` | `number` | Longitude of the venue in degrees | @gramio/types/out/objects.d.ts:7532 |
|  `title` | `string` | Name of the venue | @gramio/types/out/objects.d.ts:7536 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramInvoice.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInvoice

# Interface: TelegramInvoice

Defined in: @gramio/types/out/objects.d.ts:7748

This object contains basic information about an invoice.

[Documentation](https://core.telegram.org/bots/api/#invoice)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `currency` | [`TelegramCurrencies`](../type-aliases/TelegramCurrencies.md) | Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code, or “XTR” for payments in [Telegram Stars](https://t.me/BotNews/90) | @gramio/types/out/objects.d.ts:7764 |
|  `description` | `string` | Product description | @gramio/types/out/objects.d.ts:7756 |
|  `start_parameter` | `string` | Unique bot deep-linking parameter that can be used to generate this invoice | @gramio/types/out/objects.d.ts:7760 |
|  `title` | `string` | Product name | @gramio/types/out/objects.d.ts:7752 |
|  `total_amount` | `number` | Total price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). | @gramio/types/out/objects.d.ts:7768 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramKeyboardButton.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramKeyboardButton

# Interface: TelegramKeyboardButton

Defined in: @gramio/types/out/objects.d.ts:3045

This object represents one button of the reply keyboard. At most one of the fields other than *text*, *icon\_custom\_emoji\_id*, and *style* must be used to specify the type of the button. For simple text buttons, *String* can be used instead of this object to specify the button text.

[Documentation](https://core.telegram.org/bots/api/#keyboardbutton)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `icon_custom_emoji_id?` | `string` | *Optional*. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on [Fragment](https://fragment.com) or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription. | @gramio/types/out/objects.d.ts:3053 |
|  `request_chat?` | [`TelegramKeyboardButtonRequestChat`](TelegramKeyboardButtonRequestChat.md) | *Optional*. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat\_shared” service message. Available in private chats only. | @gramio/types/out/objects.d.ts:3065 |
|  `request_contact?` | `boolean` | *Optional*. If *True*, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only. | @gramio/types/out/objects.d.ts:3069 |
|  `request_location?` | `boolean` | *Optional*. If *True*, the user's current location will be sent when the button is pressed. Available in private chats only. | @gramio/types/out/objects.d.ts:3073 |
|  `request_poll?` | [`TelegramKeyboardButtonPollType`](TelegramKeyboardButtonPollType.md) | *Optional*. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only. | @gramio/types/out/objects.d.ts:3077 |
|  `request_users?` | [`TelegramKeyboardButtonRequestUsers`](TelegramKeyboardButtonRequestUsers.md) | *Optional*. If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users\_shared” service message. Available in private chats only. | @gramio/types/out/objects.d.ts:3061 |
|  `style?` | [`TelegramKeyboardButtonStyle`](../type-aliases/TelegramKeyboardButtonStyle.md) | *Optional*. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used. | @gramio/types/out/objects.d.ts:3057 |
|  `text` | `string` | Text of the button. If none of the fields other than *text*, *icon\_custom\_emoji\_id*, and *style* are used, it will be sent as a message when the button is pressed | @gramio/types/out/objects.d.ts:3049 |
|  `web_app?` | [`TelegramWebAppInfo`](TelegramWebAppInfo.md) | *Optional*. If specified, the described [Web App](https://core.telegram.org/bots/webapps) will be launched when the button is pressed. The Web App will be able to send a “web\_app\_data” service message. Available in private chats only. | @gramio/types/out/objects.d.ts:3081 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramKeyboardButtonPollType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramKeyboardButtonPollType

# Interface: TelegramKeyboardButtonPollType

Defined in: @gramio/types/out/objects.d.ts:3177

This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

[Documentation](https://core.telegram.org/bots/api/#keyboardbuttonpolltype)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type?` | `string` | *Optional*. If *quiz* is passed, the user will be allowed to create only polls in the quiz mode. If *regular* is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type. | @gramio/types/out/objects.d.ts:3181 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramKeyboardButtonRequestChat.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramKeyboardButtonRequestChat

# Interface: TelegramKeyboardButtonRequestChat

Defined in: @gramio/types/out/objects.d.ts:3125

This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. [More about requesting chats »](https://core.telegram.org/bots/features#chat-and-user-selection).

[Documentation](https://core.telegram.org/bots/api/#keyboardbuttonrequestchat)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `bot_administrator_rights?` | [`TelegramChatAdministratorRights`](TelegramChatAdministratorRights.md) | *Optional*. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of *user\_administrator\_rights*. If not specified, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3153 |
|  `bot_is_member?` | `boolean` | *Optional*. Pass *True* to request a chat with the bot as a member. Otherwise, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3157 |
|  `chat_has_username?` | `boolean` | *Optional*. Pass *True* to request a supergroup or a channel with a username, pass *False* to request a chat without a username. If not specified, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3141 |
|  `chat_is_channel` | `boolean` | Pass *True* to request a channel chat, pass *False* to request a group or a supergroup chat. | @gramio/types/out/objects.d.ts:3133 |
|  `chat_is_created?` | `boolean` | *Optional*. Pass *True* to request a chat owned by the user. Otherwise, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3145 |
|  `chat_is_forum?` | `boolean` | *Optional*. Pass *True* to request a forum supergroup, pass *False* to request a non-forum chat. If not specified, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3137 |
|  `request_id` | `number` | Signed 32-bit identifier of the request, which will be received back in the [ChatShared](https://core.telegram.org/bots/api#chatshared) object. Must be unique within the message | @gramio/types/out/objects.d.ts:3129 |
|  `request_photo?` | `boolean` | *Optional*. Pass *True* to request the chat's photo | @gramio/types/out/objects.d.ts:3169 |
|  `request_title?` | `boolean` | *Optional*. Pass *True* to request the chat's title | @gramio/types/out/objects.d.ts:3161 |
|  `request_username?` | `boolean` | *Optional*. Pass *True* to request the chat's username | @gramio/types/out/objects.d.ts:3165 |
|  `user_administrator_rights?` | [`TelegramChatAdministratorRights`](TelegramChatAdministratorRights.md) | *Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of *bot\_administrator\_rights*. If not specified, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3149 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramKeyboardButtonRequestUsers.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramKeyboardButtonRequestUsers

# Interface: TelegramKeyboardButtonRequestUsers

Defined in: @gramio/types/out/objects.d.ts:3089

This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. [More about requesting users »](https://core.telegram.org/bots/features#chat-and-user-selection)

[Documentation](https://core.telegram.org/bots/api/#keyboardbuttonrequestusers)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `max_quantity?` | `number` | *Optional*. The maximum number of users to be selected; 1-10. Defaults to 1. | @gramio/types/out/objects.d.ts:3105 |
|  `request_id` | `number` | Signed 32-bit identifier of the request that will be received back in the [UsersShared](https://core.telegram.org/bots/api#usersshared) object. Must be unique within the message | @gramio/types/out/objects.d.ts:3093 |
|  `request_name?` | `boolean` | *Optional*. Pass *True* to request the users' first and last names | @gramio/types/out/objects.d.ts:3109 |
|  `request_photo?` | `boolean` | *Optional*. Pass *True* to request the users' photos | @gramio/types/out/objects.d.ts:3117 |
|  `request_username?` | `boolean` | *Optional*. Pass *True* to request the users' usernames | @gramio/types/out/objects.d.ts:3113 |
|  `user_is_bot?` | `boolean` | *Optional*. Pass *True* to request bots, pass *False* to request regular users. If not specified, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3097 |
|  `user_is_premium?` | `boolean` | *Optional*. Pass *True* to request premium users, pass *False* to request non-premium users. If not specified, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3101 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramLabeledPrice.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramLabeledPrice

# Interface: TelegramLabeledPrice

Defined in: @gramio/types/out/objects.d.ts:7732

This object represents a portion of the price for goods or services.

[Documentation](https://core.telegram.org/bots/api/#labeledprice)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `amount` | `number` | Price of the product in the *smallest units* of the [currency](https://core.telegram.org/bots/payments#supported-currencies) (integer, **not** float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). | @gramio/types/out/objects.d.ts:7740 |
|  `label` | `string` | Portion label | @gramio/types/out/objects.d.ts:7736 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramLinkPreviewOptions.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramLinkPreviewOptions

# Interface: TelegramLinkPreviewOptions

Defined in: @gramio/types/out/objects.d.ts:2839

Describes the options used for link preview generation.

[Documentation](https://core.telegram.org/bots/api/#linkpreviewoptions)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `is_disabled?` | `boolean` | *Optional*. *True*, if the link preview is disabled | @gramio/types/out/objects.d.ts:2843 |
|  `prefer_large_media?` | `boolean` | *Optional*. *True*, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview | @gramio/types/out/objects.d.ts:2855 |
|  `prefer_small_media?` | `boolean` | *Optional*. *True*, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview | @gramio/types/out/objects.d.ts:2851 |
|  `show_above_text?` | `boolean` | *Optional*. *True*, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text | @gramio/types/out/objects.d.ts:2859 |
|  `url?` | `string` | *Optional*. URL to use for the link preview. If empty, then the first URL found in the message text will be used | @gramio/types/out/objects.d.ts:2847 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramLocation.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramLocation

# Interface: TelegramLocation

Defined in: @gramio/types/out/objects.d.ts:2051

This object represents a point on the map.

[Documentation](https://core.telegram.org/bots/api/#location)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `heading?` | `number` | *Optional*. The direction in which user is moving, in degrees; 1-360. For active live locations only. | @gramio/types/out/objects.d.ts:2071 |
|  `horizontal_accuracy?` | `number` | *Optional*. The radius of uncertainty for the location, measured in meters; 0-1500 | @gramio/types/out/objects.d.ts:2063 |
|  `latitude` | `number` | Latitude as defined by the sender | @gramio/types/out/objects.d.ts:2055 |
|  `live_period?` | `number` | *Optional*. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only. | @gramio/types/out/objects.d.ts:2067 |
|  `longitude` | `number` | Longitude as defined by the sender | @gramio/types/out/objects.d.ts:2059 |
|  `proximity_alert_radius?` | `number` | *Optional*. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. | @gramio/types/out/objects.d.ts:2075 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramLocationAddress.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramLocationAddress

# Interface: TelegramLocationAddress

Defined in: @gramio/types/out/objects.d.ts:4135

Describes the physical address of a location.

[Documentation](https://core.telegram.org/bots/api/#locationaddress)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `city?` | `string` | *Optional*. City of the location | @gramio/types/out/objects.d.ts:4147 |
|  `country_code` | `string` | The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located | @gramio/types/out/objects.d.ts:4139 |
|  `state?` | `string` | *Optional*. State of the location | @gramio/types/out/objects.d.ts:4143 |
|  `street?` | `string` | *Optional*. Street address of the location | @gramio/types/out/objects.d.ts:4151 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramLoginUrl.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramLoginUrl

# Interface: TelegramLoginUrl

Defined in: @gramio/types/out/objects.d.ts:3293

This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the [Telegram Login Widget](https://core.telegram.org/widgets/login) when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:

[![TITLE](https://core.telegram.org/file/811140909/1631/20k1Z53eiyY.23995/c541e89b74253623d9)](https://core.telegram.org/file/811140015/1734/8VZFkwWXalM.97872/6127fa62d8a0bf2b3c)

Telegram apps support these buttons as of [version 5.7](https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots).

> Sample bot: [@discussbot](https://t.me/discussbot)

[Documentation](https://core.telegram.org/bots/api/#loginurl)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `bot_username?` | `string` | *Optional*. Username of a bot, which will be used for user authorization. See [Setting up a bot](https://core.telegram.org/widgets/login#setting-up-a-bot) for more details. If not specified, the current bot's username will be assumed. The *url*'s domain must be the same as the domain linked with the bot. See [Linking your domain to the bot](https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot) for more details. | @gramio/types/out/objects.d.ts:3307 |
|  `forward_text?` | `string` | *Optional*. New text of the button in forwarded messages. | @gramio/types/out/objects.d.ts:3303 |
|  `request_write_access?` | `boolean` | *Optional*. Pass *True* to request the permission for your bot to send messages to the user. | @gramio/types/out/objects.d.ts:3311 |
|  `url` | `string` | An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in [Receiving authorization data](https://core.telegram.org/widgets/login#receiving-authorization-data). **NOTE:** You **must** always check the hash of the received data to verify the authentication and the integrity of the data as described in [Checking authorization](https://core.telegram.org/widgets/login#checking-authorization). | @gramio/types/out/objects.d.ts:3299 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramMaskPosition.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMaskPosition

# Interface: TelegramMaskPosition

Defined in: @gramio/types/out/objects.d.ts:6177

This object describes the position on faces where a mask should be placed by default.

[Documentation](https://core.telegram.org/bots/api/#maskposition)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `point` | [`TelegramMaskPositionPoint`](../type-aliases/TelegramMaskPositionPoint.md) | The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”. | @gramio/types/out/objects.d.ts:6181 |
|  `scale` | `number` | Mask scaling coefficient. For example, 2.0 means double size. | @gramio/types/out/objects.d.ts:6193 |
|  `x_shift` | `number` | Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position. | @gramio/types/out/objects.d.ts:6185 |
|  `y_shift` | `number` | Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position. | @gramio/types/out/objects.d.ts:6189 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramMenuButtonCommands.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMenuButtonCommands

# Interface: TelegramMenuButtonCommands

Defined in: @gramio/types/out/objects.d.ts:5292

Represents a menu button, which opens the bot's list of commands.

[Documentation](https://core.telegram.org/bots/api/#menubuttoncommands)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"commands"` | Type of the button, must be *commands* | @gramio/types/out/objects.d.ts:5296 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramMenuButtonDefault.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMenuButtonDefault

# Interface: TelegramMenuButtonDefault

Defined in: @gramio/types/out/objects.d.ts:5324

Describes that no specific value for the menu button was set.

[Documentation](https://core.telegram.org/bots/api/#menubuttondefault)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"default"` | Type of the button, must be *default* | @gramio/types/out/objects.d.ts:5328 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramMenuButtonWebApp.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMenuButtonWebApp

# Interface: TelegramMenuButtonWebApp

Defined in: @gramio/types/out/objects.d.ts:5304

Represents a menu button, which launches a [Web App](https://core.telegram.org/bots/webapps).

[Documentation](https://core.telegram.org/bots/api/#menubuttonwebapp)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `text` | `string` | Text on the button | @gramio/types/out/objects.d.ts:5312 |
|  `type` | `"web_app"` | Type of the button, must be *web\_app* | @gramio/types/out/objects.d.ts:5308 |
|  `web_app` | [`TelegramWebAppInfo`](TelegramWebAppInfo.md) | Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method [answerWebAppQuery](https://core.telegram.org/bots/api#answerwebappquery). Alternatively, a `t.me` link to a Web App of the bot can be specified in the object instead of the Web App's URL, in which case the Web App will be opened as if the user pressed the link. | @gramio/types/out/objects.d.ts:5316 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramMessage.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMessage

# Interface: TelegramMessage

Defined in: @gramio/types/out/objects.d.ts:501

This object represents a message.

[Documentation](https://core.telegram.org/bots/api/#message)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `animation?` | [`TelegramAnimation`](TelegramAnimation.md) | *Optional*. Message is an animation, information about the animation. For backward compatibility, when this field is set, the *document* field will also be set | @gramio/types/out/objects.d.ts:633 |
|  `audio?` | [`TelegramAudio`](TelegramAudio.md) | *Optional*. Message is an audio file, information about the file | @gramio/types/out/objects.d.ts:637 |
|  `author_signature?` | `string` | *Optional*. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator | @gramio/types/out/objects.d.ts:605 |
|  `boost_added?` | [`TelegramChatBoostAdded`](TelegramChatBoostAdded.md) | *Optional*. Service message: user boosted the chat | @gramio/types/out/objects.d.ts:821 |
|  `business_connection_id?` | `string` | *Optional*. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier. | @gramio/types/out/objects.d.ts:541 |
|  `caption?` | `string` | *Optional*. Caption for the animation, audio, document, paid media, photo, video or voice | @gramio/types/out/objects.d.ts:673 |
|  `caption_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption | @gramio/types/out/objects.d.ts:677 |
|  `channel_chat_created?` | `true` | *Optional*. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply\_to\_message if someone replies to a very first message in a channel. | @gramio/types/out/objects.d.ts:753 |
|  `chat` | [`TelegramChat`](TelegramChat.md) | Chat the message belongs to | @gramio/types/out/objects.d.ts:545 |
|  `chat_background_set?` | [`TelegramChatBackground`](TelegramChatBackground.md) | *Optional*. Service message: chat background set | @gramio/types/out/objects.d.ts:825 |
|  `chat_owner_changed?` | [`TelegramChatOwnerChanged`](TelegramChatOwnerChanged.md) | *Optional*. Service message: chat owner has changed | @gramio/types/out/objects.d.ts:729 |
|  `chat_owner_left?` | [`TelegramChatOwnerLeft`](TelegramChatOwnerLeft.md) | *Optional*. Service message: chat owner has left | @gramio/types/out/objects.d.ts:725 |
|  `chat_shared?` | [`TelegramChatShared`](TelegramChatShared.md) | *Optional*. Service message: a chat was shared with the bot | @gramio/types/out/objects.d.ts:789 |
|  `checklist?` | [`TelegramChecklist`](TelegramChecklist.md) | *Optional*. Message is a checklist | @gramio/types/out/objects.d.ts:689 |
|  `checklist_tasks_added?` | [`TelegramChecklistTasksAdded`](TelegramChecklistTasksAdded.md) | *Optional*. Service message: tasks were added to a checklist | @gramio/types/out/objects.d.ts:833 |
|  `checklist_tasks_done?` | [`TelegramChecklistTasksDone`](TelegramChecklistTasksDone.md) | *Optional*. Service message: some tasks in a checklist were marked as done or not done | @gramio/types/out/objects.d.ts:829 |
|  `connected_website?` | `string` | *Optional*. The domain name of the website on which the user has logged in. [More about Telegram Login »](https://core.telegram.org/widgets/login) | @gramio/types/out/objects.d.ts:805 |
|  `contact?` | [`TelegramContact`](TelegramContact.md) | *Optional*. Message is a shared contact, information about the contact | @gramio/types/out/objects.d.ts:693 |
|  `date` | `number` | Date the message was sent in Unix time. It is always a positive number, representing a valid date. | @gramio/types/out/objects.d.ts:537 |
|  `delete_chat_photo?` | `true` | *Optional*. Service message: the chat photo was deleted | @gramio/types/out/objects.d.ts:741 |
|  `dice?` | [`TelegramDice`](TelegramDice.md) | *Optional*. Message is a dice with random value | @gramio/types/out/objects.d.ts:697 |
|  `direct_message_price_changed?` | [`TelegramDirectMessagePriceChanged`](TelegramDirectMessagePriceChanged.md) | *Optional*. Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed | @gramio/types/out/objects.d.ts:837 |
|  `direct_messages_topic?` | [`TelegramDirectMessagesTopic`](TelegramDirectMessagesTopic.md) | *Optional*. Information about the direct messages chat topic that contains the message | @gramio/types/out/objects.d.ts:513 |
|  `document?` | [`TelegramDocument`](TelegramDocument.md) | *Optional*. Message is a general file, information about the file | @gramio/types/out/objects.d.ts:641 |
|  `edit_date?` | `number` | *Optional*. Date the message was last edited in Unix time | @gramio/types/out/objects.d.ts:585 |
|  `effect_id?` | `string` | *Optional*. Unique identifier of the message effect added to the message | @gramio/types/out/objects.d.ts:629 |
|  `entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text | @gramio/types/out/objects.d.ts:617 |
|  `external_reply?` | [`TelegramExternalReplyInfo`](TelegramExternalReplyInfo.md) | *Optional*. Information about the message that is being replied to, which may come from another chat or forum topic | @gramio/types/out/objects.d.ts:565 |
|  `forum_topic_closed?` | [`TelegramForumTopicClosed`](TelegramForumTopicClosed.md) | *Optional*. Service message: forum topic closed | @gramio/types/out/objects.d.ts:849 |
|  `forum_topic_created?` | [`TelegramForumTopicCreated`](TelegramForumTopicCreated.md) | *Optional*. Service message: forum topic created | @gramio/types/out/objects.d.ts:841 |
|  `forum_topic_edited?` | [`TelegramForumTopicEdited`](TelegramForumTopicEdited.md) | *Optional*. Service message: forum topic edited | @gramio/types/out/objects.d.ts:845 |
|  `forum_topic_reopened?` | [`TelegramForumTopicReopened`](TelegramForumTopicReopened.md) | *Optional*. Service message: forum topic reopened | @gramio/types/out/objects.d.ts:853 |
|  `forward_origin?` | [`TelegramMessageOrigin`](../type-aliases/TelegramMessageOrigin.md) | *Optional*. Information about the original message for forwarded messages | @gramio/types/out/objects.d.ts:549 |
|  `from?` | [`TelegramUser`](TelegramUser.md) | *Optional*. Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats | @gramio/types/out/objects.d.ts:517 |
|  `game?` | [`TelegramGame`](TelegramGame.md) | *Optional*. Message is a game, information about the game. [More about games »](https://core.telegram.org/bots/api#games) | @gramio/types/out/objects.d.ts:701 |
|  `general_forum_topic_hidden?` | [`TelegramGeneralForumTopicHidden`](TelegramGeneralForumTopicHidden.md) | *Optional*. Service message: the 'General' forum topic hidden | @gramio/types/out/objects.d.ts:857 |
|  `general_forum_topic_unhidden?` | [`TelegramGeneralForumTopicUnhidden`](TelegramGeneralForumTopicUnhidden.md) | *Optional*. Service message: the 'General' forum topic unhidden | @gramio/types/out/objects.d.ts:861 |
|  `gift?` | [`TelegramGiftInfo`](TelegramGiftInfo.md) | *Optional*. Service message: a regular gift was sent or received | @gramio/types/out/objects.d.ts:793 |
|  `gift_upgrade_sent?` | [`TelegramGiftInfo`](TelegramGiftInfo.md) | *Optional*. Service message: upgrade of a gift was purchased after the gift was sent | @gramio/types/out/objects.d.ts:801 |
|  `giveaway?` | [`TelegramGiveaway`](TelegramGiveaway.md) | *Optional*. The message is a scheduled giveaway message | @gramio/types/out/objects.d.ts:869 |
|  `giveaway_completed?` | [`TelegramGiveawayCompleted`](TelegramGiveawayCompleted.md) | *Optional*. Service message: a giveaway without public winners was completed | @gramio/types/out/objects.d.ts:877 |
|  `giveaway_created?` | [`TelegramGiveawayCreated`](TelegramGiveawayCreated.md) | *Optional*. Service message: a scheduled giveaway was created | @gramio/types/out/objects.d.ts:865 |
|  `giveaway_winners?` | [`TelegramGiveawayWinners`](TelegramGiveawayWinners.md) | *Optional*. A giveaway with public winners was completed | @gramio/types/out/objects.d.ts:873 |
|  `group_chat_created?` | `true` | *Optional*. Service message: the group has been created | @gramio/types/out/objects.d.ts:745 |
|  `has_media_spoiler?` | `true` | *Optional*. *True*, if the message media is covered by a spoiler animation | @gramio/types/out/objects.d.ts:685 |
|  `has_protected_content?` | `true` | *Optional*. *True*, if the message can't be forwarded | @gramio/types/out/objects.d.ts:589 |
|  `invoice?` | [`TelegramInvoice`](TelegramInvoice.md) | *Optional*. Message is an invoice for a [payment](https://core.telegram.org/bots/api#payments), information about the invoice. [More about payments »](https://core.telegram.org/bots/api#payments) | @gramio/types/out/objects.d.ts:773 |
|  `is_automatic_forward?` | `true` | *Optional*. *True*, if the message is a channel post that was automatically forwarded to the connected discussion group | @gramio/types/out/objects.d.ts:557 |
|  `is_from_offline?` | `true` | *Optional*. *True*, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message | @gramio/types/out/objects.d.ts:593 |
|  `is_paid_post?` | `true` | *Optional*. *True*, if the message is a paid post. Note that such posts must not be deleted for 24 hours to receive the payment and can't be edited. | @gramio/types/out/objects.d.ts:597 |
|  `is_topic_message?` | `true` | *Optional*. *True*, if the message is sent to a topic in a forum supergroup or a private chat with the bot | @gramio/types/out/objects.d.ts:553 |
|  `left_chat_member?` | [`TelegramUser`](TelegramUser.md) | *Optional*. A member was removed from the group, information about them (this member may be the bot itself) | @gramio/types/out/objects.d.ts:721 |
|  `link_preview_options?` | [`TelegramLinkPreviewOptions`](TelegramLinkPreviewOptions.md) | *Optional*. Options used for link preview generation for the message, if it is a text message and link preview options were changed | @gramio/types/out/objects.d.ts:621 |
|  `location?` | [`TelegramLocation`](TelegramLocation.md) | *Optional*. Message is a shared location, information about the location | @gramio/types/out/objects.d.ts:713 |
|  `media_group_id?` | `string` | *Optional*. The unique identifier inside this chat of a media message group this message belongs to | @gramio/types/out/objects.d.ts:601 |
|  `message_auto_delete_timer_changed?` | [`TelegramMessageAutoDeleteTimerChanged`](TelegramMessageAutoDeleteTimerChanged.md) | *Optional*. Service message: auto-delete timer settings changed in the chat | @gramio/types/out/objects.d.ts:757 |
|  `message_id` | `number` | Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent | @gramio/types/out/objects.d.ts:505 |
|  `message_thread_id?` | `number` | *Optional*. Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only | @gramio/types/out/objects.d.ts:509 |
|  `migrate_from_chat_id?` | `number` | *Optional*. The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. | @gramio/types/out/objects.d.ts:765 |
|  `migrate_to_chat_id?` | `number` | *Optional*. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. | @gramio/types/out/objects.d.ts:761 |
|  `new_chat_members?` | [`TelegramUser`](TelegramUser.md)\[] | *Optional*. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members) | @gramio/types/out/objects.d.ts:717 |
|  `new_chat_photo?` | [`TelegramPhotoSize`](TelegramPhotoSize.md)\[] | *Optional*. A chat photo was change to this value | @gramio/types/out/objects.d.ts:737 |
|  `new_chat_title?` | `string` | *Optional*. A chat title was changed to this value | @gramio/types/out/objects.d.ts:733 |
|  `paid_media?` | [`TelegramPaidMediaInfo`](TelegramPaidMediaInfo.md) | *Optional*. Message contains paid media; information about the paid media | @gramio/types/out/objects.d.ts:645 |
|  `paid_message_price_changed?` | [`TelegramPaidMessagePriceChanged`](TelegramPaidMessagePriceChanged.md) | *Optional*. Service message: the price for paid messages has changed in the chat | @gramio/types/out/objects.d.ts:881 |
|  `paid_star_count?` | `number` | *Optional*. The number of Telegram Stars that were paid by the sender of the message to send it | @gramio/types/out/objects.d.ts:609 |
|  `passport_data?` | [`TelegramPassportData`](TelegramPassportData.md) | *Optional*. Telegram Passport data | @gramio/types/out/objects.d.ts:813 |
|  `photo?` | [`TelegramPhotoSize`](TelegramPhotoSize.md)\[] | *Optional*. Message is a photo, available sizes of the photo | @gramio/types/out/objects.d.ts:649 |
|  `pinned_message?` | [`TelegramMaybeInaccessibleMessage`](../type-aliases/TelegramMaybeInaccessibleMessage.md) | *Optional*. Specified message was pinned. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain further *reply\_to\_message* fields even if it itself is a reply. | @gramio/types/out/objects.d.ts:769 |
|  `poll?` | [`TelegramPoll`](TelegramPoll.md) | *Optional*. Message is a native poll, information about the poll | @gramio/types/out/objects.d.ts:705 |
|  `proximity_alert_triggered?` | [`TelegramProximityAlertTriggered`](TelegramProximityAlertTriggered.md) | *Optional*. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location. | @gramio/types/out/objects.d.ts:817 |
|  `quote?` | [`TelegramTextQuote`](TelegramTextQuote.md) | *Optional*. For replies that quote part of the original message, the quoted part of the message | @gramio/types/out/objects.d.ts:569 |
|  `refunded_payment?` | [`TelegramRefundedPayment`](TelegramRefundedPayment.md) | *Optional*. Message is a service message about a refunded payment, information about the payment. [More about payments »](https://core.telegram.org/bots/api#payments) | @gramio/types/out/objects.d.ts:781 |
|  `reply_markup?` | [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md) | { `toJSON`: [`TelegramInlineKeyboardMarkup`](TelegramInlineKeyboardMarkup.md); } | *Optional*. [Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message. `login_url` buttons are represented as ordinary `url` buttons. | @gramio/types/out/objects.d.ts:925 |
|  `reply_to_checklist_task_id?` | `number` | *Optional*. Identifier of the specific checklist task that is being replied to | @gramio/types/out/objects.d.ts:577 |
|  `reply_to_message?` | `TelegramMessage` | *Optional*. For replies in the same chat and message thread, the original message. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain further *reply\_to\_message* fields even if it itself is a reply. | @gramio/types/out/objects.d.ts:561 |
|  `reply_to_story?` | [`TelegramStory`](TelegramStory.md) | *Optional*. For replies to a story, the original story | @gramio/types/out/objects.d.ts:573 |
|  `sender_boost_count?` | `number` | *Optional*. If the sender of the message boosted the chat, the number of boosts added by the user | @gramio/types/out/objects.d.ts:525 |
|  `sender_business_bot?` | [`TelegramUser`](TelegramUser.md) | *Optional*. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account. | @gramio/types/out/objects.d.ts:529 |
|  `sender_chat?` | [`TelegramChat`](TelegramChat.md) | *Optional*. Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel's discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field *from* contains a fake sender user in non-channel chats. | @gramio/types/out/objects.d.ts:521 |
|  `sender_tag?` | `string` | *Optional*. Tag or custom title of the sender of the message; for supergroups only | @gramio/types/out/objects.d.ts:533 |
|  `show_caption_above_media?` | `true` | *Optional*. *True*, if the caption must be shown above the message media | @gramio/types/out/objects.d.ts:681 |
|  `sticker?` | [`TelegramSticker`](TelegramSticker.md) | *Optional*. Message is a sticker, information about the sticker | @gramio/types/out/objects.d.ts:653 |
|  `story?` | [`TelegramStory`](TelegramStory.md) | *Optional*. Message is a forwarded story | @gramio/types/out/objects.d.ts:657 |
|  `successful_payment?` | [`TelegramSuccessfulPayment`](TelegramSuccessfulPayment.md) | *Optional*. Message is a service message about a successful payment, information about the payment. [More about payments »](https://core.telegram.org/bots/api#payments) | @gramio/types/out/objects.d.ts:777 |
|  `suggested_post_approval_failed?` | [`TelegramSuggestedPostApprovalFailed`](TelegramSuggestedPostApprovalFailed.md) | *Optional*. Service message: approval of a suggested post has failed | @gramio/types/out/objects.d.ts:889 |
|  `suggested_post_approved?` | [`TelegramSuggestedPostApproved`](TelegramSuggestedPostApproved.md) | *Optional*. Service message: a suggested post was approved | @gramio/types/out/objects.d.ts:885 |
|  `suggested_post_declined?` | [`TelegramSuggestedPostDeclined`](TelegramSuggestedPostDeclined.md) | *Optional*. Service message: a suggested post was declined | @gramio/types/out/objects.d.ts:893 |
|  `suggested_post_info?` | [`TelegramSuggestedPostInfo`](TelegramSuggestedPostInfo.md) | *Optional*. Information about suggested post parameters if the message is a suggested post in a channel direct messages chat. If the message is an approved or declined suggested post, then it can't be edited. | @gramio/types/out/objects.d.ts:625 |
|  `suggested_post_paid?` | [`TelegramSuggestedPostPaid`](TelegramSuggestedPostPaid.md) | *Optional*. Service message: payment for a suggested post was received | @gramio/types/out/objects.d.ts:897 |
|  `suggested_post_refunded?` | [`TelegramSuggestedPostRefunded`](TelegramSuggestedPostRefunded.md) | *Optional*. Service message: payment for a suggested post was refunded | @gramio/types/out/objects.d.ts:901 |
|  `supergroup_chat_created?` | `true` | *Optional*. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply\_to\_message if someone replies to a very first message in a directly created supergroup. | @gramio/types/out/objects.d.ts:749 |
|  `text?` | `string` | *Optional*. For text messages, the actual UTF-8 text of the message | @gramio/types/out/objects.d.ts:613 |
|  `unique_gift?` | [`TelegramUniqueGiftInfo`](TelegramUniqueGiftInfo.md) | *Optional*. Service message: a unique gift was sent or received | @gramio/types/out/objects.d.ts:797 |
|  `users_shared?` | [`TelegramUsersShared`](TelegramUsersShared.md) | *Optional*. Service message: users were shared with the bot | @gramio/types/out/objects.d.ts:785 |
|  `venue?` | [`TelegramVenue`](TelegramVenue.md) | *Optional*. Message is a venue, information about the venue. For backward compatibility, when this field is set, the *location* field will also be set | @gramio/types/out/objects.d.ts:709 |
|  `via_bot?` | [`TelegramUser`](TelegramUser.md) | *Optional*. Bot through which the message was sent | @gramio/types/out/objects.d.ts:581 |
|  `video?` | [`TelegramVideo`](TelegramVideo.md) | *Optional*. Message is a video, information about the video | @gramio/types/out/objects.d.ts:661 |
|  `video_chat_ended?` | [`TelegramVideoChatEnded`](TelegramVideoChatEnded.md) | *Optional*. Service message: video chat ended | @gramio/types/out/objects.d.ts:913 |
|  `video_chat_participants_invited?` | [`TelegramVideoChatParticipantsInvited`](TelegramVideoChatParticipantsInvited.md) | *Optional*. Service message: new participants invited to a video chat | @gramio/types/out/objects.d.ts:917 |
|  `video_chat_scheduled?` | [`TelegramVideoChatScheduled`](TelegramVideoChatScheduled.md) | *Optional*. Service message: video chat scheduled | @gramio/types/out/objects.d.ts:905 |
|  `video_chat_started?` | [`TelegramVideoChatStarted`](TelegramVideoChatStarted.md) | *Optional*. Service message: video chat started | @gramio/types/out/objects.d.ts:909 |
|  `video_note?` | [`TelegramVideoNote`](TelegramVideoNote.md) | *Optional*. Message is a [video note](https://telegram.org/blog/video-messages-and-telescope), information about the video message | @gramio/types/out/objects.d.ts:665 |
|  `voice?` | [`TelegramVoice`](TelegramVoice.md) | *Optional*. Message is a voice message, information about the file | @gramio/types/out/objects.d.ts:669 |
|  `web_app_data?` | [`TelegramWebAppData`](TelegramWebAppData.md) | *Optional*. Service message: data sent by a Web App | @gramio/types/out/objects.d.ts:921 |
|  `write_access_allowed?` | [`TelegramWriteAccessAllowed`](TelegramWriteAccessAllowed.md) | *Optional*. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method [requestWriteAccess](https://core.telegram.org/bots/webapps#initializing-mini-apps) | @gramio/types/out/objects.d.ts:809 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramMessageAutoDeleteTimerChanged.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMessageAutoDeleteTimerChanged

# Interface: TelegramMessageAutoDeleteTimerChanged

Defined in: @gramio/types/out/objects.d.ts:2155

This object represents a service message about a change in auto-delete timer settings.

[Documentation](https://core.telegram.org/bots/api/#messageautodeletetimerchanged)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `message_auto_delete_time` | `number` | New auto-delete time for messages in the chat; in seconds | @gramio/types/out/objects.d.ts:2159 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramMessageEntity.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMessageEntity

# Interface: TelegramMessageEntity

Defined in: @gramio/types/out/objects.d.ts:1001

This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

[Documentation](https://core.telegram.org/bots/api/#messageentity)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `custom_emoji_id?` | `string` | *Optional*. For “custom\_emoji” only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker | @gramio/types/out/objects.d.ts:1029 |
|  `date_time_format?` | `string` | *Optional*. For “date\_time” only, the string that defines the formatting of the date and time. See [date-time entity formatting](https://core.telegram.org/bots/api#date-time-entity-formatting) for more details. | @gramio/types/out/objects.d.ts:1037 |
|  `language?` | `string` | *Optional*. For “pre” only, the programming language of the entity text | @gramio/types/out/objects.d.ts:1025 |
|  `length` | `number` | Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) | @gramio/types/out/objects.d.ts:1013 |
|  `offset` | `number` | Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity | @gramio/types/out/objects.d.ts:1009 |
|  `type` | [`TelegramMessageEntityType`](../type-aliases/TelegramMessageEntityType.md) | Type of the entity. Currently, can be “mention” (`@username`), “hashtag” (`#hashtag` or `#hashtag@chatusername`), “cashtag” (`$USD` or `$USD@chatusername`), “bot\_command” (`/start@jobs_bot`), “url” (`https://telegram.org`), “email” (`do-not-reply@telegram.org`), “phone\_number” (`+1-212-555-0123`), “bold” (**bold text**), “italic” (*italic text*), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable\_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text\_link” (for clickable text URLs), “text\_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), “custom\_emoji” (for inline custom emoji stickers), or “date\_time” (for formatted date and time) | @gramio/types/out/objects.d.ts:1005 |
|  `unix_time?` | `number` | *Optional*. For “date\_time” only, the Unix time associated with the entity | @gramio/types/out/objects.d.ts:1033 |
|  `url?` | `string` | *Optional*. For “text\_link” only, URL that will be opened after user taps on the text | @gramio/types/out/objects.d.ts:1017 |
|  `user?` | [`TelegramUser`](TelegramUser.md) | *Optional*. For “text\_mention” only, the mentioned user | @gramio/types/out/objects.d.ts:1021 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramMessageId.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMessageId

# Interface: TelegramMessageId

Defined in: @gramio/types/out/objects.d.ts:935

This object represents a unique message identifier.

[Documentation](https://core.telegram.org/bots/api/#messageid)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `message_id` | `number` | Unique message identifier. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent | @gramio/types/out/objects.d.ts:939 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramMessageOriginChannel.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMessageOriginChannel

# Interface: TelegramMessageOriginChannel

Defined in: @gramio/types/out/objects.d.ts:1297

The message was originally sent to a channel chat.

[Documentation](https://core.telegram.org/bots/api/#messageoriginchannel)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `author_signature?` | `string` | *Optional*. Signature of the original post author | @gramio/types/out/objects.d.ts:1317 |
|  `chat` | [`TelegramChat`](TelegramChat.md) | Channel chat to which the message was originally sent | @gramio/types/out/objects.d.ts:1309 |
|  `date` | `number` | Date the message was sent originally in Unix time | @gramio/types/out/objects.d.ts:1305 |
|  `message_id` | `number` | Unique message identifier inside the chat | @gramio/types/out/objects.d.ts:1313 |
|  `type` | `"channel"` | Type of the message origin, always “channel” | @gramio/types/out/objects.d.ts:1301 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramMessageOriginChat.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMessageOriginChat

# Interface: TelegramMessageOriginChat

Defined in: @gramio/types/out/objects.d.ts:1273

The message was originally sent on behalf of a chat to a group chat.

[Documentation](https://core.telegram.org/bots/api/#messageoriginchat)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `author_signature?` | `string` | *Optional*. For messages originally sent by an anonymous chat administrator, original message author signature | @gramio/types/out/objects.d.ts:1289 |
|  `date` | `number` | Date the message was sent originally in Unix time | @gramio/types/out/objects.d.ts:1281 |
|  `sender_chat` | [`TelegramChat`](TelegramChat.md) | Chat that sent the message originally | @gramio/types/out/objects.d.ts:1285 |
|  `type` | `"chat"` | Type of the message origin, always “chat” | @gramio/types/out/objects.d.ts:1277 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramMessageOriginHiddenUser.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMessageOriginHiddenUser

# Interface: TelegramMessageOriginHiddenUser

Defined in: @gramio/types/out/objects.d.ts:1253

The message was originally sent by an unknown user.

[Documentation](https://core.telegram.org/bots/api/#messageoriginhiddenuser)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `date` | `number` | Date the message was sent originally in Unix time | @gramio/types/out/objects.d.ts:1261 |
|  `sender_user_name` | `string` | Name of the user that sent the message originally | @gramio/types/out/objects.d.ts:1265 |
|  `type` | `"hidden_user"` | Type of the message origin, always “hidden\_user” | @gramio/types/out/objects.d.ts:1257 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramMessageOriginUser.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMessageOriginUser

# Interface: TelegramMessageOriginUser

Defined in: @gramio/types/out/objects.d.ts:1233

The message was originally sent by a known user.

[Documentation](https://core.telegram.org/bots/api/#messageoriginuser)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `date` | `number` | Date the message was sent originally in Unix time | @gramio/types/out/objects.d.ts:1241 |
|  `sender_user` | [`TelegramUser`](TelegramUser.md) | User that sent the message originally | @gramio/types/out/objects.d.ts:1245 |
|  `type` | `"user"` | Type of the message origin, always “user” | @gramio/types/out/objects.d.ts:1237 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramMessageReactionCountUpdated.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMessageReactionCountUpdated

# Interface: TelegramMessageReactionCountUpdated

Defined in: @gramio/types/out/objects.d.ts:4498

This object represents reaction changes on a message with anonymous reactions.

[Documentation](https://core.telegram.org/bots/api/#messagereactioncountupdated)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat` | [`TelegramChat`](TelegramChat.md) | The chat containing the message | @gramio/types/out/objects.d.ts:4502 |
|  `date` | `number` | Date of the change in Unix time | @gramio/types/out/objects.d.ts:4510 |
|  `message_id` | `number` | Unique message identifier inside the chat | @gramio/types/out/objects.d.ts:4506 |
|  `reactions` | [`TelegramReactionCount`](TelegramReactionCount.md)\[] | List of reactions that are present on the message | @gramio/types/out/objects.d.ts:4514 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramMessageReactionUpdated.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMessageReactionUpdated

# Interface: TelegramMessageReactionUpdated

Defined in: @gramio/types/out/objects.d.ts:4462

This object represents a change of a reaction on a message performed by a user.

[Documentation](https://core.telegram.org/bots/api/#messagereactionupdated)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `actor_chat?` | [`TelegramChat`](TelegramChat.md) | *Optional*. The chat on behalf of which the reaction was changed, if the user is anonymous | @gramio/types/out/objects.d.ts:4478 |
|  `chat` | [`TelegramChat`](TelegramChat.md) | The chat containing the message the user reacted to | @gramio/types/out/objects.d.ts:4466 |
|  `date` | `number` | Date of the change in Unix time | @gramio/types/out/objects.d.ts:4482 |
|  `message_id` | `number` | Unique identifier of the message inside the chat | @gramio/types/out/objects.d.ts:4470 |
|  `new_reaction` | [`TelegramReactionType`](../type-aliases/TelegramReactionType.md)\[] | New list of reaction types that have been set by the user | @gramio/types/out/objects.d.ts:4490 |
|  `old_reaction` | [`TelegramReactionType`](../type-aliases/TelegramReactionType.md)\[] | Previous list of reaction types that were set by the user | @gramio/types/out/objects.d.ts:4486 |
|  `user?` | [`TelegramUser`](TelegramUser.md) | *Optional*. The user that changed the reaction, if the user isn't anonymous | @gramio/types/out/objects.d.ts:4474 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramOrderInfo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramOrderInfo

# Interface: TelegramOrderInfo

Defined in: @gramio/types/out/objects.d.ts:7808

This object represents information about an order.

[Documentation](https://core.telegram.org/bots/api/#orderinfo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `email?` | `string` | *Optional*. User email | @gramio/types/out/objects.d.ts:7820 |
|  `name?` | `string` | *Optional*. User name | @gramio/types/out/objects.d.ts:7812 |
|  `phone_number?` | `string` | *Optional*. User's phone number | @gramio/types/out/objects.d.ts:7816 |
|  `shipping_address?` | [`TelegramShippingAddress`](TelegramShippingAddress.md) | *Optional*. User shipping address | @gramio/types/out/objects.d.ts:7824 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramOwnedGiftRegular.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramOwnedGiftRegular

# Interface: TelegramOwnedGiftRegular

Defined in: @gramio/types/out/objects.d.ts:4928

Describes a regular gift owned by a user or a chat.

[Documentation](https://core.telegram.org/bots/api/#ownedgiftregular)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `can_be_upgraded?` | `true` | *Optional*. *True*, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:4968 |
|  `convert_star_count?` | `number` | *Optional*. Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:4976 |
|  `entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. Special entities that appear in the text | @gramio/types/out/objects.d.ts:4956 |
|  `gift` | [`TelegramGift`](TelegramGift.md) | Information about the regular gift | @gramio/types/out/objects.d.ts:4936 |
|  `is_private?` | `true` | *Optional*. *True*, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them | @gramio/types/out/objects.d.ts:4960 |
|  `is_saved?` | `true` | *Optional*. *True*, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:4964 |
|  `is_upgrade_separate?` | `true` | *Optional*. *True*, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:4984 |
|  `owned_gift_id?` | `string` | *Optional*. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:4940 |
|  `prepaid_upgrade_star_count?` | `number` | *Optional*. Number of Telegram Stars that were paid for the ability to upgrade the gift | @gramio/types/out/objects.d.ts:4980 |
|  `send_date` | `number` | Date the gift was sent in Unix time | @gramio/types/out/objects.d.ts:4948 |
|  `sender_user?` | [`TelegramUser`](TelegramUser.md) | *Optional*. Sender of the gift if it is a known user | @gramio/types/out/objects.d.ts:4944 |
|  `text?` | `string` | *Optional*. Text of the message that was added to the gift | @gramio/types/out/objects.d.ts:4952 |
|  `type` | `"regular"` | Type of the gift, always “regular” | @gramio/types/out/objects.d.ts:4932 |
|  `unique_gift_number?` | `number` | *Optional*. Unique number reserved for this gift when upgraded. See the *number* field in [UniqueGift](https://core.telegram.org/bots/api#uniquegift) | @gramio/types/out/objects.d.ts:4988 |
|  `was_refunded?` | `true` | *Optional*. *True*, if the gift was refunded and isn't available anymore | @gramio/types/out/objects.d.ts:4972 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramOwnedGifts.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramOwnedGifts

# Interface: TelegramOwnedGifts

Defined in: @gramio/types/out/objects.d.ts:5040

Contains the list of gifts received and owned by a user or a chat.

[Documentation](https://core.telegram.org/bots/api/#ownedgifts)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `gifts` | [`TelegramOwnedGift`](../type-aliases/TelegramOwnedGift.md)\[] | The list of gifts | @gramio/types/out/objects.d.ts:5048 |
|  `next_offset?` | `string` | *Optional*. Offset for the next request. If empty, then there are no more results | @gramio/types/out/objects.d.ts:5052 |
|  `total_count` | `number` | The total number of gifts owned by the user or the chat | @gramio/types/out/objects.d.ts:5044 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramOwnedGiftUnique.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramOwnedGiftUnique

# Interface: TelegramOwnedGiftUnique

Defined in: @gramio/types/out/objects.d.ts:4996

Describes a unique gift received and owned by a user or a chat.

[Documentation](https://core.telegram.org/bots/api/#ownedgiftunique)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `can_be_transferred?` | `true` | *Optional*. *True*, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:5024 |
|  `gift` | [`TelegramUniqueGift`](TelegramUniqueGift.md) | Information about the unique gift | @gramio/types/out/objects.d.ts:5004 |
|  `is_saved?` | `true` | *Optional*. *True*, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:5020 |
|  `next_transfer_date?` | `number` | *Optional*. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now | @gramio/types/out/objects.d.ts:5032 |
|  `owned_gift_id?` | `string` | *Optional*. Unique identifier of the received gift for the bot; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:5008 |
|  `send_date` | `number` | Date the gift was sent in Unix time | @gramio/types/out/objects.d.ts:5016 |
|  `sender_user?` | [`TelegramUser`](TelegramUser.md) | *Optional*. Sender of the gift if it is a known user | @gramio/types/out/objects.d.ts:5012 |
|  `transfer_star_count?` | `number` | *Optional*. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift | @gramio/types/out/objects.d.ts:5028 |
|  `type` | `"unique"` | Type of the gift, always “unique” | @gramio/types/out/objects.d.ts:5000 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPaidMediaInfo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPaidMediaInfo

# Interface: TelegramPaidMediaInfo

Defined in: @gramio/types/out/objects.d.ts:1639

Describes the paid media added to a message.

[Documentation](https://core.telegram.org/bots/api/#paidmediainfo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `paid_media` | [`TelegramPaidMedia`](../type-aliases/TelegramPaidMedia.md)\[] | Information about the paid media | @gramio/types/out/objects.d.ts:1647 |
|  `star_count` | `number` | The number of Telegram Stars that must be paid to buy access to the media | @gramio/types/out/objects.d.ts:1643 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPaidMediaPhoto.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPaidMediaPhoto

# Interface: TelegramPaidMediaPhoto

Defined in: @gramio/types/out/objects.d.ts:1693

The paid media is a photo.

[Documentation](https://core.telegram.org/bots/api/#paidmediaphoto)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `photo` | [`TelegramPhotoSize`](TelegramPhotoSize.md)\[] | The photo | @gramio/types/out/objects.d.ts:1701 |
|  `type` | `"photo"` | Type of the paid media, always “photo” | @gramio/types/out/objects.d.ts:1697 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPaidMediaPreview.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPaidMediaPreview

# Interface: TelegramPaidMediaPreview

Defined in: @gramio/types/out/objects.d.ts:1669

The paid media isn't available before the payment.

[Documentation](https://core.telegram.org/bots/api/#paidmediapreview)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `duration?` | `number` | *Optional*. Duration of the media in seconds as defined by the sender | @gramio/types/out/objects.d.ts:1685 |
|  `height?` | `number` | *Optional*. Media height as defined by the sender | @gramio/types/out/objects.d.ts:1681 |
|  `type` | `"preview"` | Type of the paid media, always “preview” | @gramio/types/out/objects.d.ts:1673 |
|  `width?` | `number` | *Optional*. Media width as defined by the sender | @gramio/types/out/objects.d.ts:1677 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPaidMediaPurchased.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPaidMediaPurchased

# Interface: TelegramPaidMediaPurchased

Defined in: @gramio/types/out/objects.d.ts:7988

This object contains information about a paid media purchase.

[Documentation](https://core.telegram.org/bots/api/#paidmediapurchased)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `from` | [`TelegramUser`](TelegramUser.md) | User who purchased the media | @gramio/types/out/objects.d.ts:7992 |
|  `paid_media_payload` | `string` | Bot-specified paid media payload | @gramio/types/out/objects.d.ts:7996 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPaidMediaVideo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPaidMediaVideo

# Interface: TelegramPaidMediaVideo

Defined in: @gramio/types/out/objects.d.ts:1709

The paid media is a video.

[Documentation](https://core.telegram.org/bots/api/#paidmediavideo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"video"` | Type of the paid media, always “video” | @gramio/types/out/objects.d.ts:1713 |
|  `video` | [`TelegramVideo`](TelegramVideo.md) | The video | @gramio/types/out/objects.d.ts:1717 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPaidMessagePriceChanged.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPaidMessagePriceChanged

# Interface: TelegramPaidMessagePriceChanged

Defined in: @gramio/types/out/objects.d.ts:2576

Describes a service message about a change in the price of paid messages within a chat.

[Documentation](https://core.telegram.org/bots/api/#paidmessagepricechanged)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `paid_message_star_count` | `number` | The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message | @gramio/types/out/objects.d.ts:2580 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPassportData.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportData

# Interface: TelegramPassportData

Defined in: @gramio/types/out/objects.d.ts:8307

Describes Telegram Passport data shared with the bot by the user.

[Documentation](https://core.telegram.org/bots/api/#passportdata)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `credentials` | [`TelegramEncryptedCredentials`](TelegramEncryptedCredentials.md) | Encrypted credentials required to decrypt the data | @gramio/types/out/objects.d.ts:8315 |
|  `data` | [`TelegramEncryptedPassportElement`](TelegramEncryptedPassportElement.md)\[] | Array with information about documents and other Telegram Passport elements that was shared with the bot | @gramio/types/out/objects.d.ts:8311 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramPassportElementErrorDataField.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorDataField

# Interface: TelegramPassportElementErrorDataField

Defined in: @gramio/types/out/objects.d.ts:8464

Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.

[Documentation](https://core.telegram.org/bots/api/#passportelementerrordatafield)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `data_hash` | `string` | Base64-encoded data hash | @gramio/types/out/objects.d.ts:8480 |
|  `field_name` | `string` | Name of the data field which has the error | @gramio/types/out/objects.d.ts:8476 |
|  `message` | `string` | Error message | @gramio/types/out/objects.d.ts:8484 |
|  `source` | `"data"` | Error source, must be *data* | @gramio/types/out/objects.d.ts:8468 |
|  `type` | [`TelegramPassportElementErrorDataFieldType`](../type-aliases/TelegramPassportElementErrorDataFieldType.md) | The section of the user's Telegram Passport which has the error, one of “personal\_details”, “passport”, “driver\_license”, “identity\_card”, “internal\_passport”, “address” | @gramio/types/out/objects.d.ts:8472 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPassportElementErrorFile.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorFile

# Interface: TelegramPassportElementErrorFile

Defined in: @gramio/types/out/objects.d.ts:8587

Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.

[Documentation](https://core.telegram.org/bots/api/#passportelementerrorfile)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `file_hash` | `string` | Base64-encoded file hash | @gramio/types/out/objects.d.ts:8599 |
|  `message` | `string` | Error message | @gramio/types/out/objects.d.ts:8603 |
|  `source` | `"file"` | Error source, must be *file* | @gramio/types/out/objects.d.ts:8591 |
|  `type` | [`TelegramPassportElementErrorFileType`](../type-aliases/TelegramPassportElementErrorFileType.md) | The section of the user's Telegram Passport which has the issue, one of “utility\_bill”, “bank\_statement”, “rental\_agreement”, “passport\_registration”, “temporary\_registration” | @gramio/types/out/objects.d.ts:8595 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPassportElementErrorFiles.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorFiles

# Interface: TelegramPassportElementErrorFiles

Defined in: @gramio/types/out/objects.d.ts:8618

Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.

[Documentation](https://core.telegram.org/bots/api/#passportelementerrorfiles)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `file_hashes` | `string`\[] | List of base64-encoded file hashes | @gramio/types/out/objects.d.ts:8630 |
|  `message` | `string` | Error message | @gramio/types/out/objects.d.ts:8634 |
|  `source` | `"files"` | Error source, must be *files* | @gramio/types/out/objects.d.ts:8622 |
|  `type` | [`TelegramPassportElementErrorFilesType`](../type-aliases/TelegramPassportElementErrorFilesType.md) | The section of the user's Telegram Passport which has the issue, one of “utility\_bill”, “bank\_statement”, “rental\_agreement”, “passport\_registration”, “temporary\_registration” | @gramio/types/out/objects.d.ts:8626 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramPassportElementErrorFrontSide.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorFrontSide

# Interface: TelegramPassportElementErrorFrontSide

Defined in: @gramio/types/out/objects.d.ts:8498

Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.

[Documentation](https://core.telegram.org/bots/api/#passportelementerrorfrontside)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `file_hash` | `string` | Base64-encoded hash of the file with the front side of the document | @gramio/types/out/objects.d.ts:8510 |
|  `message` | `string` | Error message | @gramio/types/out/objects.d.ts:8514 |
|  `source` | `"front_side"` | Error source, must be *front\_side* | @gramio/types/out/objects.d.ts:8502 |
|  `type` | [`TelegramPassportElementErrorFrontSideType`](../type-aliases/TelegramPassportElementErrorFrontSideType.md) | The section of the user's Telegram Passport which has the issue, one of “passport”, “driver\_license”, “identity\_card”, “internal\_passport” | @gramio/types/out/objects.d.ts:8506 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramPassportElementErrorReverseSide.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorReverseSide

# Interface: TelegramPassportElementErrorReverseSide

Defined in: @gramio/types/out/objects.d.ts:8526

Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.

[Documentation](https://core.telegram.org/bots/api/#passportelementerrorreverseside)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `file_hash` | `string` | Base64-encoded hash of the file with the reverse side of the document | @gramio/types/out/objects.d.ts:8538 |
|  `message` | `string` | Error message | @gramio/types/out/objects.d.ts:8542 |
|  `source` | `"reverse_side"` | Error source, must be *reverse\_side* | @gramio/types/out/objects.d.ts:8530 |
|  `type` | [`TelegramPassportElementErrorReverseSideType`](../type-aliases/TelegramPassportElementErrorReverseSideType.md) | The section of the user's Telegram Passport which has the issue, one of “driver\_license”, “identity\_card” | @gramio/types/out/objects.d.ts:8534 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPassportElementErrorSelfie.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorSelfie

# Interface: TelegramPassportElementErrorSelfie

Defined in: @gramio/types/out/objects.d.ts:8556

Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.

[Documentation](https://core.telegram.org/bots/api/#passportelementerrorselfie)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `file_hash` | `string` | Base64-encoded hash of the file with the selfie | @gramio/types/out/objects.d.ts:8568 |
|  `message` | `string` | Error message | @gramio/types/out/objects.d.ts:8572 |
|  `source` | `"selfie"` | Error source, must be *selfie* | @gramio/types/out/objects.d.ts:8560 |
|  `type` | [`TelegramPassportElementErrorSelfieType`](../type-aliases/TelegramPassportElementErrorSelfieType.md) | The section of the user's Telegram Passport which has the issue, one of “passport”, “driver\_license”, “identity\_card”, “internal\_passport” | @gramio/types/out/objects.d.ts:8564 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramPassportElementErrorTranslationFile.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorTranslationFile

# Interface: TelegramPassportElementErrorTranslationFile

Defined in: @gramio/types/out/objects.d.ts:8653

Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.

[Documentation](https://core.telegram.org/bots/api/#passportelementerrortranslationfile)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `file_hash` | `string` | Base64-encoded file hash | @gramio/types/out/objects.d.ts:8665 |
|  `message` | `string` | Error message | @gramio/types/out/objects.d.ts:8669 |
|  `source` | `"translation_file"` | Error source, must be *translation\_file* | @gramio/types/out/objects.d.ts:8657 |
|  `type` | [`TelegramPassportElementErrorTranslationFileType`](../type-aliases/TelegramPassportElementErrorTranslationFileType.md) | Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver\_license”, “identity\_card”, “internal\_passport”, “utility\_bill”, “bank\_statement”, “rental\_agreement”, “passport\_registration”, “temporary\_registration” | @gramio/types/out/objects.d.ts:8661 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramPassportElementErrorTranslationFiles.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorTranslationFiles

# Interface: TelegramPassportElementErrorTranslationFiles

Defined in: @gramio/types/out/objects.d.ts:8688

Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.

[Documentation](https://core.telegram.org/bots/api/#passportelementerrortranslationfiles)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `file_hashes` | `string`\[] | List of base64-encoded file hashes | @gramio/types/out/objects.d.ts:8700 |
|  `message` | `string` | Error message | @gramio/types/out/objects.d.ts:8704 |
|  `source` | `"translation_files"` | Error source, must be *translation\_files* | @gramio/types/out/objects.d.ts:8692 |
|  `type` | [`TelegramPassportElementErrorTranslationFilesType`](../type-aliases/TelegramPassportElementErrorTranslationFilesType.md) | Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver\_license”, “identity\_card”, “internal\_passport”, “utility\_bill”, “bank\_statement”, “rental\_agreement”, “passport\_registration”, “temporary\_registration” | @gramio/types/out/objects.d.ts:8696 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramPassportElementErrorUnspecified.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorUnspecified

# Interface: TelegramPassportElementErrorUnspecified

Defined in: @gramio/types/out/objects.d.ts:8712

Represents an issue in an unspecified place. The error is considered resolved when new data is added.

[Documentation](https://core.telegram.org/bots/api/#passportelementerrorunspecified)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `element_hash` | `string` | Base64-encoded element hash | @gramio/types/out/objects.d.ts:8724 |
|  `message` | `string` | Error message | @gramio/types/out/objects.d.ts:8728 |
|  `source` | `"unspecified"` | Error source, must be *unspecified* | @gramio/types/out/objects.d.ts:8716 |
|  `type` | `string` | Type of element of the user's Telegram Passport which has the issue | @gramio/types/out/objects.d.ts:8720 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPassportFile.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportFile

# Interface: TelegramPassportFile

Defined in: @gramio/types/out/objects.d.ts:8323

This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.

[Documentation](https://core.telegram.org/bots/api/#passportfile)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `file_date` | `number` | Unix time when the file was uploaded | @gramio/types/out/objects.d.ts:8339 |
|  `file_id` | `string` | Identifier for this file, which can be used to download or reuse the file | @gramio/types/out/objects.d.ts:8327 |
|  `file_size` | `number` | File size in bytes | @gramio/types/out/objects.d.ts:8335 |
|  `file_unique_id` | `string` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:8331 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPhotoSize.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPhotoSize

# Interface: TelegramPhotoSize

Defined in: @gramio/types/out/objects.d.ts:1325

This object represents one size of a photo or a [file](https://core.telegram.org/bots/api#document) / [sticker](https://core.telegram.org/bots/api#sticker) thumbnail.

[Documentation](https://core.telegram.org/bots/api/#photosize)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `file_id` | `string` | Identifier for this file, which can be used to download or reuse the file | @gramio/types/out/objects.d.ts:1329 |
|  `file_size?` | `number` | *Optional*. File size in bytes | @gramio/types/out/objects.d.ts:1345 |
|  `file_unique_id` | `string` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:1333 |
|  `height` | `number` | Photo height | @gramio/types/out/objects.d.ts:1341 |
|  `width` | `number` | Photo width | @gramio/types/out/objects.d.ts:1337 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPoll.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPoll

# Interface: TelegramPoll

Defined in: @gramio/types/out/objects.d.ts:1835

This object contains information about a poll.

[Documentation](https://core.telegram.org/bots/api/#poll)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allows_multiple_answers` | `boolean` | *True*, if the poll allows multiple answers | @gramio/types/out/objects.d.ts:1871 |
|  `close_date?` | `number` | *Optional*. Point in time (Unix timestamp) when the poll will be automatically closed | @gramio/types/out/objects.d.ts:1891 |
|  `correct_option_id?` | `number` | *Optional*. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot. | @gramio/types/out/objects.d.ts:1875 |
|  `explanation?` | `string` | *Optional*. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters | @gramio/types/out/objects.d.ts:1879 |
|  `explanation_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. Special entities like usernames, URLs, bot commands, etc. that appear in the *explanation* | @gramio/types/out/objects.d.ts:1883 |
|  `id` | `string` | Unique poll identifier | @gramio/types/out/objects.d.ts:1839 |
|  `is_anonymous` | `boolean` | *True*, if the poll is anonymous | @gramio/types/out/objects.d.ts:1863 |
|  `is_closed` | `boolean` | *True*, if the poll is closed | @gramio/types/out/objects.d.ts:1859 |
|  `open_period?` | `number` | *Optional*. Amount of time in seconds the poll will be active after creation | @gramio/types/out/objects.d.ts:1887 |
|  `options` | [`TelegramPollOption`](TelegramPollOption.md)\[] | List of poll options | @gramio/types/out/objects.d.ts:1851 |
|  `question` | `string` | Poll question, 1-300 characters | @gramio/types/out/objects.d.ts:1843 |
|  `question_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. Special entities that appear in the *question*. Currently, only custom emoji entities are allowed in poll questions | @gramio/types/out/objects.d.ts:1847 |
|  `total_voter_count` | `number` | Total number of users that voted in the poll | @gramio/types/out/objects.d.ts:1855 |
|  `type` | [`TelegramPollType`](../type-aliases/TelegramPollType.md) | Poll type, currently can be “regular” or “quiz” | @gramio/types/out/objects.d.ts:1867 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPollAnswer.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPollAnswer

# Interface: TelegramPollAnswer

Defined in: @gramio/types/out/objects.d.ts:1809

This object represents an answer of a user in a non-anonymous poll.

[Documentation](https://core.telegram.org/bots/api/#pollanswer)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `option_ids` | `number`\[] | 0-based identifiers of chosen answer options. May be empty if the vote was retracted. | @gramio/types/out/objects.d.ts:1825 |
|  `poll_id` | `string` | Unique poll identifier | @gramio/types/out/objects.d.ts:1813 |
|  `user?` | [`TelegramUser`](TelegramUser.md) | *Optional*. The user that changed the answer to the poll, if the voter isn't anonymous | @gramio/types/out/objects.d.ts:1821 |
|  `voter_chat?` | [`TelegramChat`](TelegramChat.md) | *Optional*. The chat that changed the answer to the poll, if the voter is anonymous | @gramio/types/out/objects.d.ts:1817 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPollOption.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPollOption

# Interface: TelegramPollOption

Defined in: @gramio/types/out/objects.d.ts:1769

This object contains information about one answer option in a poll.

[Documentation](https://core.telegram.org/bots/api/#polloption)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `text` | `string` | Option text, 1-100 characters | @gramio/types/out/objects.d.ts:1773 |
|  `text_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. Special entities that appear in the option *text*. Currently, only custom emoji entities are allowed in poll option texts | @gramio/types/out/objects.d.ts:1777 |
|  `voter_count` | `number` | Number of users that voted for this option | @gramio/types/out/objects.d.ts:1781 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPreCheckoutQuery.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPreCheckoutQuery

# Interface: TelegramPreCheckoutQuery

Defined in: @gramio/types/out/objects.d.ts:7952

This object contains information about an incoming pre-checkout query.

[Documentation](https://core.telegram.org/bots/api/#precheckoutquery)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `currency` | [`TelegramCurrencies`](../type-aliases/TelegramCurrencies.md) | Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code, or “XTR” for payments in [Telegram Stars](https://t.me/BotNews/90) | @gramio/types/out/objects.d.ts:7964 |
|  `from` | [`TelegramUser`](TelegramUser.md) | User who sent the query | @gramio/types/out/objects.d.ts:7960 |
|  `id` | `string` | Unique query identifier | @gramio/types/out/objects.d.ts:7956 |
|  `invoice_payload` | `string` | Bot-specified invoice payload | @gramio/types/out/objects.d.ts:7972 |
|  `order_info?` | [`TelegramOrderInfo`](TelegramOrderInfo.md) | *Optional*. Order information provided by the user | @gramio/types/out/objects.d.ts:7980 |
|  `shipping_option_id?` | `string` | *Optional*. Identifier of the shipping option chosen by the user | @gramio/types/out/objects.d.ts:7976 |
|  `total_amount` | `number` | Total price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). | @gramio/types/out/objects.d.ts:7968 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramPreparedInlineMessage.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPreparedInlineMessage

# Interface: TelegramPreparedInlineMessage

Defined in: @gramio/types/out/objects.d.ts:7716

Describes an inline message to be sent by a user of a Mini App.

[Documentation](https://core.telegram.org/bots/api/#preparedinlinemessage)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `expiration_date` | `number` | Expiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used | @gramio/types/out/objects.d.ts:7724 |
|  `id` | `string` | Unique identifier of the prepared message | @gramio/types/out/objects.d.ts:7720 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramProximityAlertTriggered.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramProximityAlertTriggered

# Interface: TelegramProximityAlertTriggered

Defined in: @gramio/types/out/objects.d.ts:2135

This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

[Documentation](https://core.telegram.org/bots/api/#proximityalerttriggered)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `distance` | `number` | The distance between the users | @gramio/types/out/objects.d.ts:2147 |
|  `traveler` | [`TelegramUser`](TelegramUser.md) | User that triggered the alert | @gramio/types/out/objects.d.ts:2139 |
|  `watcher` | [`TelegramUser`](TelegramUser.md) | User that set the alert | @gramio/types/out/objects.d.ts:2143 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramReactionCount.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramReactionCount

# Interface: TelegramReactionCount

Defined in: @gramio/types/out/objects.d.ts:4446

Represents a reaction added to a message along with the number of times it was added.

[Documentation](https://core.telegram.org/bots/api/#reactioncount)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `total_count` | `number` | Number of times the reaction was added | @gramio/types/out/objects.d.ts:4454 |
|  `type` | [`TelegramReactionType`](../type-aliases/TelegramReactionType.md) | Type of the reaction | @gramio/types/out/objects.d.ts:4450 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramReactionTypeCustomEmoji.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramReactionTypeCustomEmoji

# Interface: TelegramReactionTypeCustomEmoji

Defined in: @gramio/types/out/objects.d.ts:4418

The reaction is based on a custom emoji.

[Documentation](https://core.telegram.org/bots/api/#reactiontypecustomemoji)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `custom_emoji_id` | `string` | Custom emoji identifier | @gramio/types/out/objects.d.ts:4426 |
|  `type` | `"custom_emoji"` | Type of the reaction, always “custom\_emoji” | @gramio/types/out/objects.d.ts:4422 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramReactionTypeEmoji.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramReactionTypeEmoji

# Interface: TelegramReactionTypeEmoji

Defined in: @gramio/types/out/objects.d.ts:4402

The reaction is based on an emoji.

[Documentation](https://core.telegram.org/bots/api/#reactiontypeemoji)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `emoji` | [`TelegramReactionTypeEmojiEmoji`](../type-aliases/TelegramReactionTypeEmojiEmoji.md) | Reaction emoji. Currently, it can be one of "![❤](https://telegram.org/img/emoji/40/E29DA4.png)", "![👍](https://telegram.org/img/emoji/40/F09F918D.png)", "![👎](https://telegram.org/img/emoji/40/F09F918E.png)", "![🔥](https://telegram.org/img/emoji/40/F09F94A5.png)", "![🥰](https://telegram.org/img/emoji/40/F09FA5B0.png)", "![👏](https://telegram.org/img/emoji/40/F09F918F.png)", "![😁](https://telegram.org/img/emoji/40/F09F9881.png)", "![🤔](https://telegram.org/img/emoji/40/F09FA494.png)", "![🤯](https://telegram.org/img/emoji/40/F09FA4AF.png)", "![😱](https://telegram.org/img/emoji/40/F09F98B1.png)", "![🤬](https://telegram.org/img/emoji/40/F09FA4AC.png)", "![😢](https://telegram.org/img/emoji/40/F09F98A2.png)", "![🎉](https://telegram.org/img/emoji/40/F09F8E89.png)", "![🤩](https://telegram.org/img/emoji/40/F09FA4A9.png)", "![🤮](https://telegram.org/img/emoji/40/F09FA4AE.png)", "![💩](https://telegram.org/img/emoji/40/F09F92A9.png)", "![🙏](https://telegram.org/img/emoji/40/F09F998F.png)", "![👌](https://telegram.org/img/emoji/40/F09F918C.png)", "![🕊](https://telegram.org/img/emoji/40/F09F958A.png)", "![🤡](https://telegram.org/img/emoji/40/F09FA4A1.png)", "![🥱](https://telegram.org/img/emoji/40/F09FA5B1.png)", "![🥴](https://telegram.org/img/emoji/40/F09FA5B4.png)", "![😍](https://telegram.org/img/emoji/40/F09F988D.png)", "![🐳](https://telegram.org/img/emoji/40/F09F90B3.png)", "![❤‍🔥](https://telegram.org/img/emoji/40/E29DA4E2808DF09F94A5.png)", "![🌚](https://telegram.org/img/emoji/40/F09F8C9A.png)", "![🌭](https://telegram.org/img/emoji/40/F09F8CAD.png)", "![💯](https://telegram.org/img/emoji/40/F09F92AF.png)", "![🤣](https://telegram.org/img/emoji/40/F09FA4A3.png)", "![⚡](https://telegram.org/img/emoji/40/E29AA1.png)", "![🍌](https://telegram.org/img/emoji/40/F09F8D8C.png)", "![🏆](https://telegram.org/img/emoji/40/F09F8F86.png)", "![💔](https://telegram.org/img/emoji/40/F09F9294.png)", "![🤨](https://telegram.org/img/emoji/40/F09FA4A8.png)", "![😐](https://telegram.org/img/emoji/40/F09F9890.png)", "![🍓](https://telegram.org/img/emoji/40/F09F8D93.png)", "![🍾](https://telegram.org/img/emoji/40/F09F8DBE.png)", "![💋](https://telegram.org/img/emoji/40/F09F928B.png)", "![🖕](https://telegram.org/img/emoji/40/F09F9695.png)", "![😈](https://telegram.org/img/emoji/40/F09F9888.png)", "![😴](https://telegram.org/img/emoji/40/F09F98B4.png)", "![😭](https://telegram.org/img/emoji/40/F09F98AD.png)", "![🤓](https://telegram.org/img/emoji/40/F09FA493.png)", "![👻](https://telegram.org/img/emoji/40/F09F91BB.png)", "![👨‍💻](https://telegram.org/img/emoji/40/F09F91A8E2808DF09F92BB.png)", "![👀](https://telegram.org/img/emoji/40/F09F9180.png)", "![🎃](https://telegram.org/img/emoji/40/F09F8E83.png)", "![🙈](https://telegram.org/img/emoji/40/F09F9988.png)", "![😇](https://telegram.org/img/emoji/40/F09F9887.png)", "![😨](https://telegram.org/img/emoji/40/F09F98A8.png)", "![🤝](https://telegram.org/img/emoji/40/F09FA49D.png)", "![✍](https://telegram.org/img/emoji/40/E29C8D.png)", "![🤗](https://telegram.org/img/emoji/40/F09FA497.png)", "![🫡](https://telegram.org/img/emoji/40/F09FABA1.png)", "![🎅](https://telegram.org/img/emoji/40/F09F8E85.png)", "![🎄](https://telegram.org/img/emoji/40/F09F8E84.png)", "![☃](https://telegram.org/img/emoji/40/E29883.png)", "![💅](https://telegram.org/img/emoji/40/F09F9285.png)", "![🤪](https://telegram.org/img/emoji/40/F09FA4AA.png)", "![🗿](https://telegram.org/img/emoji/40/F09F97BF.png)", "![🆒](https://telegram.org/img/emoji/40/F09F8692.png)", "![💘](https://telegram.org/img/emoji/40/F09F9298.png)", "![🙉](https://telegram.org/img/emoji/40/F09F9989.png)", "![🦄](https://telegram.org/img/emoji/40/F09FA684.png)", "![😘](https://telegram.org/img/emoji/40/F09F9898.png)", "![💊](https://telegram.org/img/emoji/40/F09F928A.png)", "![🙊](https://telegram.org/img/emoji/40/F09F998A.png)", "![😎](https://telegram.org/img/emoji/40/F09F988E.png)", "![👾](https://telegram.org/img/emoji/40/F09F91BE.png)", "![🤷‍♂](https://telegram.org/img/emoji/40/F09FA4B7E2808DE29982.png)", "![🤷](https://telegram.org/img/emoji/40/F09FA4B7.png)", "![🤷‍♀](https://telegram.org/img/emoji/40/F09FA4B7E2808DE29980.png)", "![😡](https://telegram.org/img/emoji/40/F09F98A1.png)" | @gramio/types/out/objects.d.ts:4410 |
|  `type` | `"emoji"` | Type of the reaction, always “emoji” | @gramio/types/out/objects.d.ts:4406 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramReactionTypePaid.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramReactionTypePaid

# Interface: TelegramReactionTypePaid

Defined in: @gramio/types/out/objects.d.ts:4434

The reaction is paid.

[Documentation](https://core.telegram.org/bots/api/#reactiontypepaid)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"paid"` | Type of the reaction, always “paid” | @gramio/types/out/objects.d.ts:4438 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramRefundedPayment.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramRefundedPayment

# Interface: TelegramRefundedPayment

Defined in: @gramio/types/out/objects.d.ts:7900

This object contains basic information about a refunded payment.

[Documentation](https://core.telegram.org/bots/api/#refundedpayment)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `currency` | [`TelegramCurrencies`](../type-aliases/TelegramCurrencies.md) | Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code, or “XTR” for payments in [Telegram Stars](https://t.me/BotNews/90). Currently, always “XTR” | @gramio/types/out/objects.d.ts:7904 |
|  `invoice_payload` | `string` | Bot-specified invoice payload | @gramio/types/out/objects.d.ts:7912 |
|  `provider_payment_charge_id?` | `string` | *Optional*. Provider payment identifier | @gramio/types/out/objects.d.ts:7920 |
|  `telegram_payment_charge_id` | `string` | Telegram payment identifier | @gramio/types/out/objects.d.ts:7916 |
|  `total_amount` | `number` | Total refunded price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of `US$ 1.45`, `total_amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). | @gramio/types/out/objects.d.ts:7908 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramReplyKeyboardMarkup.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramReplyKeyboardMarkup

# Interface: TelegramReplyKeyboardMarkup

Defined in: @gramio/types/out/objects.d.ts:3009

This object represents a [custom keyboard](https://core.telegram.org/bots/features#keyboards) with reply options (see [Introduction to bots](https://core.telegram.org/bots/features#keyboards) for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.

[Documentation](https://core.telegram.org/bots/api/#replykeyboardmarkup)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `input_field_placeholder?` | `string` | *Optional*. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters | @gramio/types/out/objects.d.ts:3029 |
|  `is_persistent?` | `boolean` | *Optional*. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to *false*, in which case the custom keyboard can be hidden and opened with a keyboard icon. | @gramio/types/out/objects.d.ts:3017 |
|  `keyboard` | [`TelegramKeyboardButton`](TelegramKeyboardButton.md)\[]\[] | Array of button rows, each represented by an Array of [KeyboardButton](https://core.telegram.org/bots/api#keyboardbutton) objects | @gramio/types/out/objects.d.ts:3013 |
|  `one_time_keyboard?` | `boolean` | *Optional*. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to *false*. | @gramio/types/out/objects.d.ts:3025 |
|  `resize_keyboard?` | `boolean` | *Optional*. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to *false*, in which case the custom keyboard is always of the same height as the app's standard keyboard. | @gramio/types/out/objects.d.ts:3021 |
|  `selective?` | `boolean` | *Optional*. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are **Mentioned** in the *text* of the [Message](https://core.telegram.org/bots/api#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. *Example:* A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard. | @gramio/types/out/objects.d.ts:3035 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramReplyKeyboardRemove.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramReplyKeyboardRemove

# Interface: TelegramReplyKeyboardRemove

Defined in: @gramio/types/out/objects.d.ts:3189

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 (see [ReplyKeyboardMarkup](https://core.telegram.org/bots/api#replykeyboardmarkup)). Not supported in channels and for messages sent on behalf of a Telegram Business account.

[Documentation](https://core.telegram.org/bots/api/#replykeyboardremove)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `remove_keyboard` | `true` | Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use *one\_time\_keyboard* in [ReplyKeyboardMarkup](https://core.telegram.org/bots/api#replykeyboardmarkup)) | @gramio/types/out/objects.d.ts:3193 |
|  `selective?` | `boolean` | *Optional*. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are **Mentioned** in the *text* of the [Message](https://core.telegram.org/bots/api#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. *Example:* A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet. | @gramio/types/out/objects.d.ts:3199 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramReplyParameters.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramReplyParameters

# Interface: TelegramReplyParameters

Defined in: @gramio/types/out/objects.d.ts:1177

Describes reply parameters for the message that is being sent.

[Documentation](https://core.telegram.org/bots/api/#replyparameters)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_sending_without_reply?` | `boolean` | *Optional*. Pass *True* if the message should be sent even if the specified message to be replied to is not found. Always *False* for replies in another chat or forum topic. Always *True* for messages sent on behalf of a business account. | @gramio/types/out/objects.d.ts:1189 |
|  `chat_id?` | `string` | `number` | *Optional*. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format `@channelusername`). Not supported for messages sent on behalf of a business account and messages from channel direct messages chats. | @gramio/types/out/objects.d.ts:1185 |
|  `checklist_task_id?` | `number` | *Optional*. Identifier of the specific checklist task to be replied to | @gramio/types/out/objects.d.ts:1209 |
|  `message_id` | `number` | Identifier of the message that will be replied to in the current chat, or in the chat *chat\_id* if it is specified | @gramio/types/out/objects.d.ts:1181 |
|  `quote?` | `string` | { `toString`: `string`; } | *Optional*. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including *bold*, *italic*, *underline*, *strikethrough*, *spoiler*, and *custom\_emoji* entities. The message will fail to send if the quote isn't found in the original message. | @gramio/types/out/objects.d.ts:1193 |
|  `quote_entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of *quote\_parse\_mode*. | @gramio/types/out/objects.d.ts:1201 |
|  `quote_parse_mode?` | `"HTML"` | `"MarkdownV2"` | `"Markdown"` | *Optional*. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. | @gramio/types/out/objects.d.ts:1197 |
|  `quote_position?` | `number` | *Optional*. Position of the quote in the original message in UTF-16 code units | @gramio/types/out/objects.d.ts:1205 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramResponseParameters.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramResponseParameters

# Interface: TelegramResponseParameters

Defined in: @gramio/types/out/objects.d.ts:5626

Describes why a request was unsuccessful.

[Documentation](https://core.telegram.org/bots/api/#responseparameters)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `migrate_to_chat_id?` | `number` | *Optional*. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. | @gramio/types/out/objects.d.ts:5630 |
|  `retry_after?` | `number` | *Optional*. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated | @gramio/types/out/objects.d.ts:5634 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramRevenueWithdrawalStateFailed.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramRevenueWithdrawalStateFailed

# Interface: TelegramRevenueWithdrawalStateFailed

Defined in: @gramio/types/out/objects.d.ts:8050

The withdrawal failed and the transaction was refunded.

[Documentation](https://core.telegram.org/bots/api/#revenuewithdrawalstatefailed)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"failed"` | Type of the state, always “failed” | @gramio/types/out/objects.d.ts:8054 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramRevenueWithdrawalStatePending.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramRevenueWithdrawalStatePending

# Interface: TelegramRevenueWithdrawalStatePending

Defined in: @gramio/types/out/objects.d.ts:8018

The withdrawal is in progress.

[Documentation](https://core.telegram.org/bots/api/#revenuewithdrawalstatepending)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"pending"` | Type of the state, always “pending” | @gramio/types/out/objects.d.ts:8022 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramRevenueWithdrawalStateSucceeded.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramRevenueWithdrawalStateSucceeded

# Interface: TelegramRevenueWithdrawalStateSucceeded

Defined in: @gramio/types/out/objects.d.ts:8030

The withdrawal succeeded.

[Documentation](https://core.telegram.org/bots/api/#revenuewithdrawalstatesucceeded)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `date` | `number` | Date the withdrawal was completed in Unix time | @gramio/types/out/objects.d.ts:8038 |
|  `type` | `"succeeded"` | Type of the state, always “succeeded” | @gramio/types/out/objects.d.ts:8034 |
|  `url` | `string` | An HTTPS URL that can be used to see transaction details | @gramio/types/out/objects.d.ts:8042 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramSentWebAppMessage.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSentWebAppMessage

# Interface: TelegramSentWebAppMessage

Defined in: @gramio/types/out/objects.d.ts:7704

Describes an inline message sent by a [Web App](https://core.telegram.org/bots/webapps) on behalf of a user.

[Documentation](https://core.telegram.org/bots/api/#sentwebappmessage)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `inline_message_id?` | `string` | *Optional*. Identifier of the sent inline message. Available only if there is an [inline keyboard](https://core.telegram.org/bots/api#inlinekeyboardmarkup) attached to the message. | @gramio/types/out/objects.d.ts:7708 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramSharedUser.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSharedUser

# Interface: TelegramSharedUser

Defined in: @gramio/types/out/objects.d.ts:2441

This object contains information about a user that was shared with the bot using a [KeyboardButtonRequestUsers](https://core.telegram.org/bots/api#keyboardbuttonrequestusers) button.

[Documentation](https://core.telegram.org/bots/api/#shareduser)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `first_name?` | `string` | *Optional*. First name of the user, if the name was requested by the bot | @gramio/types/out/objects.d.ts:2449 |
|  `last_name?` | `string` | *Optional*. Last name of the user, if the name was requested by the bot | @gramio/types/out/objects.d.ts:2453 |
|  `photo?` | [`TelegramPhotoSize`](TelegramPhotoSize.md)\[] | *Optional*. Available sizes of the chat photo, if the photo was requested by the bot | @gramio/types/out/objects.d.ts:2461 |
|  `user_id` | `number` | Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means. | @gramio/types/out/objects.d.ts:2445 |
|  `username?` | `string` | *Optional*. Username of the user, if the username was requested by the bot | @gramio/types/out/objects.d.ts:2457 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramShippingAddress.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramShippingAddress

# Interface: TelegramShippingAddress

Defined in: @gramio/types/out/objects.d.ts:7776

This object represents a shipping address.

[Documentation](https://core.telegram.org/bots/api/#shippingaddress)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `city` | `string` | City | @gramio/types/out/objects.d.ts:7788 |
|  `country_code` | `string` | Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code | @gramio/types/out/objects.d.ts:7780 |
|  `post_code` | `string` | Address post code | @gramio/types/out/objects.d.ts:7800 |
|  `state` | `string` | State, if applicable | @gramio/types/out/objects.d.ts:7784 |
|  `street_line1` | `string` | First line for the address | @gramio/types/out/objects.d.ts:7792 |
|  `street_line2` | `string` | Second line for the address | @gramio/types/out/objects.d.ts:7796 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramShippingOption.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramShippingOption

# Interface: TelegramShippingOption

Defined in: @gramio/types/out/objects.d.ts:7832

This object represents one shipping option.

[Documentation](https://core.telegram.org/bots/api/#shippingoption)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `id` | `string` | Shipping option identifier | @gramio/types/out/objects.d.ts:7836 |
|  `prices` | [`TelegramLabeledPrice`](TelegramLabeledPrice.md)\[] | List of price portions | @gramio/types/out/objects.d.ts:7844 |
|  `title` | `string` | Option title | @gramio/types/out/objects.d.ts:7840 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramShippingQuery.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramShippingQuery

# Interface: TelegramShippingQuery

Defined in: @gramio/types/out/objects.d.ts:7928

This object contains information about an incoming shipping query.

[Documentation](https://core.telegram.org/bots/api/#shippingquery)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `from` | [`TelegramUser`](TelegramUser.md) | User who sent the query | @gramio/types/out/objects.d.ts:7936 |
|  `id` | `string` | Unique query identifier | @gramio/types/out/objects.d.ts:7932 |
|  `invoice_payload` | `string` | Bot-specified invoice payload | @gramio/types/out/objects.d.ts:7940 |
|  `shipping_address` | [`TelegramShippingAddress`](TelegramShippingAddress.md) | User specified shipping address | @gramio/types/out/objects.d.ts:7944 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramStarAmount.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStarAmount

# Interface: TelegramStarAmount

Defined in: @gramio/types/out/objects.d.ts:5088

Describes an amount of Telegram Stars.

[Documentation](https://core.telegram.org/bots/api/#staramount)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `amount` | `number` | Integer amount of Telegram Stars, rounded to 0; can be negative | @gramio/types/out/objects.d.ts:5092 |
|  `nanostar_amount?` | `number` | *Optional*. The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999; can be negative if and only if *amount* is non-positive | @gramio/types/out/objects.d.ts:5096 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramStarTransaction.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStarTransaction

# Interface: TelegramStarTransaction

Defined in: @gramio/types/out/objects.d.ts:8263

Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.

[Documentation](https://core.telegram.org/bots/api/#startransaction)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `amount` | `number` | Integer amount of Telegram Stars transferred by the transaction | @gramio/types/out/objects.d.ts:8271 |
|  `date` | `number` | Date the transaction was created in Unix time | @gramio/types/out/objects.d.ts:8279 |
|  `id` | `string` | Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with *SuccessfulPayment.telegram\_payment\_charge\_id* for successful incoming payments from users. | @gramio/types/out/objects.d.ts:8267 |
|  `nanostar_amount?` | `number` | *Optional*. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999 | @gramio/types/out/objects.d.ts:8275 |
|  `receiver?` | [`TelegramTransactionPartner`](../type-aliases/TelegramTransactionPartner.md) | *Optional*. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions | @gramio/types/out/objects.d.ts:8287 |
|  `source?` | [`TelegramTransactionPartner`](../type-aliases/TelegramTransactionPartner.md) | *Optional*. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions | @gramio/types/out/objects.d.ts:8283 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramStarTransactions.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStarTransactions

# Interface: TelegramStarTransactions

Defined in: @gramio/types/out/objects.d.ts:8295

Contains a list of Telegram Star transactions.

[Documentation](https://core.telegram.org/bots/api/#startransactions)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `transactions` | [`TelegramStarTransaction`](TelegramStarTransaction.md)\[] | The list of transactions | @gramio/types/out/objects.d.ts:8299 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramSticker.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSticker

# Interface: TelegramSticker

Defined in: @gramio/types/out/objects.d.ts:6077

This object represents a sticker.

[Documentation](https://core.telegram.org/bots/api/#sticker)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `custom_emoji_id?` | `string` | *Optional*. For custom emoji stickers, unique identifier of the custom emoji | @gramio/types/out/objects.d.ts:6129 |
|  `emoji?` | `string` | *Optional*. Emoji associated with the sticker | @gramio/types/out/objects.d.ts:6113 |
|  `file_id` | `string` | Identifier for this file, which can be used to download or reuse the file | @gramio/types/out/objects.d.ts:6081 |
|  `file_size?` | `number` | *Optional*. File size in bytes | @gramio/types/out/objects.d.ts:6137 |
|  `file_unique_id` | `string` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:6085 |
|  `height` | `number` | Sticker height | @gramio/types/out/objects.d.ts:6097 |
|  `is_animated` | `boolean` | *True*, if the sticker is [animated](https://telegram.org/blog/animated-stickers) | @gramio/types/out/objects.d.ts:6101 |
|  `is_video` | `boolean` | *True*, if the sticker is a [video sticker](https://telegram.org/blog/video-stickers-better-reactions) | @gramio/types/out/objects.d.ts:6105 |
|  `mask_position?` | [`TelegramMaskPosition`](TelegramMaskPosition.md) | *Optional*. For mask stickers, the position where the mask should be placed | @gramio/types/out/objects.d.ts:6125 |
|  `needs_repainting?` | `true` | *Optional*. *True*, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places | @gramio/types/out/objects.d.ts:6133 |
|  `premium_animation?` | [`TelegramFile`](TelegramFile.md) | *Optional*. For premium regular stickers, premium animation for the sticker | @gramio/types/out/objects.d.ts:6121 |
|  `set_name?` | `string` | *Optional*. Name of the sticker set to which the sticker belongs | @gramio/types/out/objects.d.ts:6117 |
|  `thumbnail?` | [`TelegramPhotoSize`](TelegramPhotoSize.md) | *Optional*. Sticker thumbnail in the .WEBP or .JPG format | @gramio/types/out/objects.d.ts:6109 |
|  `type` | [`TelegramStickerType`](../type-aliases/TelegramStickerType.md) | Type of the sticker, currently one of “regular”, “mask”, “custom\_emoji”. The type of the sticker is independent from its format, which is determined by the fields *is\_animated* and *is\_video*. | @gramio/types/out/objects.d.ts:6089 |
|  `width` | `number` | Sticker width | @gramio/types/out/objects.d.ts:6093 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramStickerSet.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStickerSet

# Interface: TelegramStickerSet

Defined in: @gramio/types/out/objects.d.ts:6147

This object represents a sticker set.

[Documentation](https://core.telegram.org/bots/api/#stickerset)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `name` | `string` | Sticker set name | @gramio/types/out/objects.d.ts:6151 |
|  `sticker_type` | [`TelegramStickerSetStickerType`](../type-aliases/TelegramStickerSetStickerType.md) | Type of stickers in the set, currently one of “regular”, “mask”, “custom\_emoji” | @gramio/types/out/objects.d.ts:6159 |
|  `stickers` | [`TelegramSticker`](TelegramSticker.md)\[] | List of all set stickers | @gramio/types/out/objects.d.ts:6163 |
|  `thumbnail?` | [`TelegramPhotoSize`](TelegramPhotoSize.md) | *Optional*. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format | @gramio/types/out/objects.d.ts:6167 |
|  `title` | `string` | Sticker set title | @gramio/types/out/objects.d.ts:6155 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramStory.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStory

# Interface: TelegramStory

Defined in: @gramio/types/out/objects.d.ts:1473

This object represents a story.

[Documentation](https://core.telegram.org/bots/api/#story)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat` | [`TelegramChat`](TelegramChat.md) | Chat that posted the story | @gramio/types/out/objects.d.ts:1477 |
|  `id` | `number` | Unique identifier for the story in the chat | @gramio/types/out/objects.d.ts:1481 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramStoryArea.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStoryArea

# Interface: TelegramStoryArea

Defined in: @gramio/types/out/objects.d.ts:4281

Describes a clickable area on a story media.

[Documentation](https://core.telegram.org/bots/api/#storyarea)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `position` | [`TelegramStoryAreaPosition`](TelegramStoryAreaPosition.md) | Position of the area | @gramio/types/out/objects.d.ts:4285 |
|  `type` | [`TelegramStoryAreaType`](../type-aliases/TelegramStoryAreaType.md) | Type of the area | @gramio/types/out/objects.d.ts:4289 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramStoryAreaPosition.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStoryAreaPosition

# Interface: TelegramStoryAreaPosition

Defined in: @gramio/types/out/objects.d.ts:4103

Describes the position of a clickable area within a story.

[Documentation](https://core.telegram.org/bots/api/#storyareaposition)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `corner_radius_percentage` | `number` | The radius of the rectangle corner rounding, as a percentage of the media width | @gramio/types/out/objects.d.ts:4127 |
|  `height_percentage` | `number` | The height of the area's rectangle, as a percentage of the media height | @gramio/types/out/objects.d.ts:4119 |
|  `rotation_angle` | `number` | The clockwise rotation angle of the rectangle, in degrees; 0-360 | @gramio/types/out/objects.d.ts:4123 |
|  `width_percentage` | `number` | The width of the area's rectangle, as a percentage of the media width | @gramio/types/out/objects.d.ts:4115 |
|  `x_percentage` | `number` | The abscissa of the area's center, as a percentage of the media width | @gramio/types/out/objects.d.ts:4107 |
|  `y_percentage` | `number` | The ordinate of the area's center, as a percentage of the media height | @gramio/types/out/objects.d.ts:4111 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramStoryAreaTypeLink.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStoryAreaTypeLink

# Interface: TelegramStoryAreaTypeLink

Defined in: @gramio/types/out/objects.d.ts:4225

Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.

[Documentation](https://core.telegram.org/bots/api/#storyareatypelink)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"link"` | Type of the area, always “link” | @gramio/types/out/objects.d.ts:4229 |
|  `url` | `string` | HTTP or tg:// URL to be opened when the area is clicked | @gramio/types/out/objects.d.ts:4233 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramStoryAreaTypeLocation.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStoryAreaTypeLocation

# Interface: TelegramStoryAreaTypeLocation

Defined in: @gramio/types/out/objects.d.ts:4177

Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.

[Documentation](https://core.telegram.org/bots/api/#storyareatypelocation)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `address?` | [`TelegramLocationAddress`](TelegramLocationAddress.md) | *Optional*. Address of the location | @gramio/types/out/objects.d.ts:4193 |
|  `latitude` | `number` | Location latitude in degrees | @gramio/types/out/objects.d.ts:4185 |
|  `longitude` | `number` | Location longitude in degrees | @gramio/types/out/objects.d.ts:4189 |
|  `type` | `"location"` | Type of the area, always “location” | @gramio/types/out/objects.d.ts:4181 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramStoryAreaTypeSuggestedReaction.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStoryAreaTypeSuggestedReaction

# Interface: TelegramStoryAreaTypeSuggestedReaction

Defined in: @gramio/types/out/objects.d.ts:4201

Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.

[Documentation](https://core.telegram.org/bots/api/#storyareatypesuggestedreaction)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `is_dark?` | `boolean` | *Optional*. Pass *True* if the reaction area has a dark background | @gramio/types/out/objects.d.ts:4213 |
|  `is_flipped?` | `boolean` | *Optional*. Pass *True* if reaction area corner is flipped | @gramio/types/out/objects.d.ts:4217 |
|  `reaction_type` | [`TelegramReactionType`](../type-aliases/TelegramReactionType.md) | Type of the reaction | @gramio/types/out/objects.d.ts:4209 |
|  `type` | `"suggested_reaction"` | Type of the area, always “suggested\_reaction” | @gramio/types/out/objects.d.ts:4205 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramStoryAreaTypeUniqueGift.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStoryAreaTypeUniqueGift

# Interface: TelegramStoryAreaTypeUniqueGift

Defined in: @gramio/types/out/objects.d.ts:4265

Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.

[Documentation](https://core.telegram.org/bots/api/#storyareatypeuniquegift)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `name` | `string` | Unique name of the gift | @gramio/types/out/objects.d.ts:4273 |
|  `type` | `"unique_gift"` | Type of the area, always “unique\_gift” | @gramio/types/out/objects.d.ts:4269 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramStoryAreaTypeWeather.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStoryAreaTypeWeather

# Interface: TelegramStoryAreaTypeWeather

Defined in: @gramio/types/out/objects.d.ts:4241

Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.

[Documentation](https://core.telegram.org/bots/api/#storyareatypeweather)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `background_color` | `number` | A color of the area background in the ARGB format | @gramio/types/out/objects.d.ts:4257 |
|  `emoji` | `string` | Emoji representing the weather | @gramio/types/out/objects.d.ts:4253 |
|  `temperature` | `number` | Temperature, in degree Celsius | @gramio/types/out/objects.d.ts:4249 |
|  `type` | `"weather"` | Type of the area, always “weather” | @gramio/types/out/objects.d.ts:4245 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramSuccessfulPayment.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuccessfulPayment

# Interface: TelegramSuccessfulPayment

Defined in: @gramio/types/out/objects.d.ts:7852

This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.

[Documentation](https://core.telegram.org/bots/api/#successfulpayment)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `currency` | [`TelegramCurrencies`](../type-aliases/TelegramCurrencies.md) | Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code, or “XTR” for payments in [Telegram Stars](https://t.me/BotNews/90) | @gramio/types/out/objects.d.ts:7856 |
|  `invoice_payload` | `string` | Bot-specified invoice payload | @gramio/types/out/objects.d.ts:7864 |
|  `is_first_recurring?` | `true` | *Optional*. *True*, if the payment is the first payment for a subscription | @gramio/types/out/objects.d.ts:7876 |
|  `is_recurring?` | `true` | *Optional*. *True*, if the payment is a recurring payment for a subscription | @gramio/types/out/objects.d.ts:7872 |
|  `order_info?` | [`TelegramOrderInfo`](TelegramOrderInfo.md) | *Optional*. Order information provided by the user | @gramio/types/out/objects.d.ts:7884 |
|  `provider_payment_charge_id` | `string` | Provider payment identifier | @gramio/types/out/objects.d.ts:7892 |
|  `shipping_option_id?` | `string` | *Optional*. Identifier of the shipping option chosen by the user | @gramio/types/out/objects.d.ts:7880 |
|  `subscription_expiration_date?` | `number` | *Optional*. Expiration date of the subscription, in Unix time; for recurring payments only | @gramio/types/out/objects.d.ts:7868 |
|  `telegram_payment_charge_id` | `string` | Telegram payment identifier | @gramio/types/out/objects.d.ts:7888 |
|  `total_amount` | `number` | Total price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). | @gramio/types/out/objects.d.ts:7860 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramSuggestedPostApprovalFailed.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuggestedPostApprovalFailed

# Interface: TelegramSuggestedPostApprovalFailed

Defined in: @gramio/types/out/objects.d.ts:2624

Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient user funds at the time of approval.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostapprovalfailed)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `price` | [`TelegramSuggestedPostPrice`](TelegramSuggestedPostPrice.md) | Expected price of the post | @gramio/types/out/objects.d.ts:2632 |
|  `suggested_post_message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. Message containing the suggested post whose approval has failed. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply\_to\_message* field even if it itself is a reply. | @gramio/types/out/objects.d.ts:2628 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramSuggestedPostApproved.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuggestedPostApproved

# Interface: TelegramSuggestedPostApproved

Defined in: @gramio/types/out/objects.d.ts:2604

Describes a service message about the approval of a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostapproved)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `price?` | [`TelegramSuggestedPostPrice`](TelegramSuggestedPostPrice.md) | *Optional*. Amount paid for the post | @gramio/types/out/objects.d.ts:2612 |
|  `send_date` | `number` | Date when the post will be published | @gramio/types/out/objects.d.ts:2616 |
|  `suggested_post_message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. Message containing the suggested post. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply\_to\_message* field even if it itself is a reply. | @gramio/types/out/objects.d.ts:2608 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramSuggestedPostDeclined.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuggestedPostDeclined

# Interface: TelegramSuggestedPostDeclined

Defined in: @gramio/types/out/objects.d.ts:2640

Describes a service message about the rejection of a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostdeclined)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `comment?` | `string` | *Optional*. Comment with which the post was declined | @gramio/types/out/objects.d.ts:2648 |
|  `suggested_post_message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. Message containing the suggested post. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply\_to\_message* field even if it itself is a reply. | @gramio/types/out/objects.d.ts:2644 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramSuggestedPostInfo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuggestedPostInfo

# Interface: TelegramSuggestedPostInfo

Defined in: @gramio/types/out/objects.d.ts:2887

Contains information about a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostinfo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `price?` | [`TelegramSuggestedPostPrice`](TelegramSuggestedPostPrice.md) | *Optional*. Proposed price of the post. If the field is omitted, then the post is unpaid. | @gramio/types/out/objects.d.ts:2895 |
|  `send_date?` | `number` | *Optional*. Proposed send date of the post. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user or administrator who approves it. | @gramio/types/out/objects.d.ts:2899 |
|  `state` | [`TelegramSuggestedPostInfoState`](../type-aliases/TelegramSuggestedPostInfoState.md) | State of the suggested post. Currently, it can be one of “pending”, “approved”, “declined”. | @gramio/types/out/objects.d.ts:2891 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramSuggestedPostPaid.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuggestedPostPaid

# Interface: TelegramSuggestedPostPaid

Defined in: @gramio/types/out/objects.d.ts:2658

Describes a service message about a successful payment for a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostpaid)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `amount?` | `number` | *Optional*. The amount of the currency that was received by the channel in nanotoncoins; for payments in toncoins only | @gramio/types/out/objects.d.ts:2670 |
|  `currency` | [`TelegramSuggestedPostPaidCurrency`](../type-aliases/TelegramSuggestedPostPaidCurrency.md) | Currency in which the payment was made. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins | @gramio/types/out/objects.d.ts:2666 |
|  `star_amount?` | [`TelegramStarAmount`](TelegramStarAmount.md) | *Optional*. The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only | @gramio/types/out/objects.d.ts:2674 |
|  `suggested_post_message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. Message containing the suggested post. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply\_to\_message* field even if it itself is a reply. | @gramio/types/out/objects.d.ts:2662 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramSuggestedPostParameters.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuggestedPostParameters

# Interface: TelegramSuggestedPostParameters

Defined in: @gramio/types/out/objects.d.ts:2907

Contains parameters of a post that is being suggested by the bot.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostparameters)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `price?` | [`TelegramSuggestedPostPrice`](TelegramSuggestedPostPrice.md) | *Optional*. Proposed price for the post. If the field is omitted, then the post is unpaid. | @gramio/types/out/objects.d.ts:2911 |
|  `send_date?` | `number` | *Optional*. Proposed send date of the post. If specified, then the date must be between 300 second and 2678400 seconds (30 days) in the future. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user who approves it. | @gramio/types/out/objects.d.ts:2915 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramSuggestedPostPrice.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuggestedPostPrice

# Interface: TelegramSuggestedPostPrice

Defined in: @gramio/types/out/objects.d.ts:2869

Describes the price of a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostprice)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `amount` | `number` | The amount of the currency that will be paid for the post in the *smallest units* of the currency, i.e. Telegram Stars or nanotoncoins. Currently, price in Telegram Stars must be between 5 and 100000, and price in nanotoncoins must be between 10000000 and 10000000000000. | @gramio/types/out/objects.d.ts:2877 |
|  `currency` | [`TelegramSuggestedPostPriceCurrency`](../type-aliases/TelegramSuggestedPostPriceCurrency.md) | Currency in which the post will be paid. Currently, must be one of “XTR” for Telegram Stars or “TON” for toncoins | @gramio/types/out/objects.d.ts:2873 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramSuggestedPostRefunded.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuggestedPostRefunded

# Interface: TelegramSuggestedPostRefunded

Defined in: @gramio/types/out/objects.d.ts:2687

Describes a service message about a payment refund for a suggested post.

[Documentation](https://core.telegram.org/bots/api/#suggestedpostrefunded)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `reason` | [`TelegramSuggestedPostRefundedReason`](../type-aliases/TelegramSuggestedPostRefundedReason.md) | Reason for the refund. Currently, one of “post\_deleted” if the post was deleted within 24 hours of being posted or removed from scheduled messages without being posted, or “payment\_refunded” if the payer refunded their payment. | @gramio/types/out/objects.d.ts:2695 |
|  `suggested_post_message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. Message containing the suggested post. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply\_to\_message* field even if it itself is a reply. | @gramio/types/out/objects.d.ts:2691 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramSwitchInlineQueryChosenChat.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSwitchInlineQueryChosenChat

# Interface: TelegramSwitchInlineQueryChosenChat

Defined in: @gramio/types/out/objects.d.ts:3319

This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.

[Documentation](https://core.telegram.org/bots/api/#switchinlinequerychosenchat)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allow_bot_chats?` | `boolean` | *Optional*. *True*, if private chats with bots can be chosen | @gramio/types/out/objects.d.ts:3331 |
|  `allow_channel_chats?` | `boolean` | *Optional*. *True*, if channel chats can be chosen | @gramio/types/out/objects.d.ts:3339 |
|  `allow_group_chats?` | `boolean` | *Optional*. *True*, if group and supergroup chats can be chosen | @gramio/types/out/objects.d.ts:3335 |
|  `allow_user_chats?` | `boolean` | *Optional*. *True*, if private chats with users can be chosen | @gramio/types/out/objects.d.ts:3327 |
|  `query?` | `string` | *Optional*. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted | @gramio/types/out/objects.d.ts:3323 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramTextQuote.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramTextQuote

# Interface: TelegramTextQuote

Defined in: @gramio/types/out/objects.d.ts:1045

This object contains information about the quoted part of a message that is replied to by the given message.

[Documentation](https://core.telegram.org/bots/api/#textquote)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `entities?` | [`TelegramMessageEntity`](TelegramMessageEntity.md)\[] | *Optional*. Special entities that appear in the quote. Currently, only *bold*, *italic*, *underline*, *strikethrough*, *spoiler*, and *custom\_emoji* entities are kept in quotes. | @gramio/types/out/objects.d.ts:1053 |
|  `is_manual?` | `true` | *Optional*. *True*, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server. | @gramio/types/out/objects.d.ts:1061 |
|  `position` | `number` | Approximate quote position in the original message in UTF-16 code units as specified by the sender | @gramio/types/out/objects.d.ts:1057 |
|  `text` | `string` | Text of the quoted part of a message that is replied to by the given message | @gramio/types/out/objects.d.ts:1049 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramTransactionPartnerAffiliateProgram.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramTransactionPartnerAffiliateProgram

# Interface: TelegramTransactionPartnerAffiliateProgram

Defined in: @gramio/types/out/objects.d.ts:8187

Describes the affiliate program that issued the affiliate commission received via this transaction.

[Documentation](https://core.telegram.org/bots/api/#transactionpartneraffiliateprogram)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `commission_per_mille` | `number` | The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users | @gramio/types/out/objects.d.ts:8199 |
|  `sponsor_user?` | [`TelegramUser`](TelegramUser.md) | *Optional*. Information about the bot that sponsored the affiliate program | @gramio/types/out/objects.d.ts:8195 |
|  `type` | `"affiliate_program"` | Type of the transaction partner, always “affiliate\_program” | @gramio/types/out/objects.d.ts:8191 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramTransactionPartnerChat.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramTransactionPartnerChat

# Interface: TelegramTransactionPartnerChat

Defined in: @gramio/types/out/objects.d.ts:8167

Describes a transaction with a chat.

[Documentation](https://core.telegram.org/bots/api/#transactionpartnerchat)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat` | [`TelegramChat`](TelegramChat.md) | Information about the chat | @gramio/types/out/objects.d.ts:8175 |
|  `gift?` | [`TelegramGift`](TelegramGift.md) | *Optional*. The gift sent to the chat by the bot | @gramio/types/out/objects.d.ts:8179 |
|  `type` | `"chat"` | Type of the transaction partner, always “chat” | @gramio/types/out/objects.d.ts:8171 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramTransactionPartnerFragment.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramTransactionPartnerFragment

# Interface: TelegramTransactionPartnerFragment

Defined in: @gramio/types/out/objects.d.ts:8207

Describes a withdrawal transaction with Fragment.

[Documentation](https://core.telegram.org/bots/api/#transactionpartnerfragment)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"fragment"` | Type of the transaction partner, always “fragment” | @gramio/types/out/objects.d.ts:8211 |
|  `withdrawal_state?` | [`TelegramRevenueWithdrawalState`](../type-aliases/TelegramRevenueWithdrawalState.md) | *Optional*. State of the transaction if the transaction is outgoing | @gramio/types/out/objects.d.ts:8215 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramTransactionPartnerOther.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramTransactionPartnerOther

# Interface: TelegramTransactionPartnerOther

Defined in: @gramio/types/out/objects.d.ts:8251

Describes a transaction with an unknown source or recipient.

[Documentation](https://core.telegram.org/bots/api/#transactionpartnerother)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"other"` | Type of the transaction partner, always “other” | @gramio/types/out/objects.d.ts:8255 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramTransactionPartnerTelegramAds.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramTransactionPartnerTelegramAds

# Interface: TelegramTransactionPartnerTelegramAds

Defined in: @gramio/types/out/objects.d.ts:8223

Describes a withdrawal transaction to the Telegram Ads platform.

[Documentation](https://core.telegram.org/bots/api/#transactionpartnertelegramads)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `type` | `"telegram_ads"` | Type of the transaction partner, always “telegram\_ads” | @gramio/types/out/objects.d.ts:8227 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramTransactionPartnerTelegramApi.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramTransactionPartnerTelegramApi

# Interface: TelegramTransactionPartnerTelegramApi

Defined in: @gramio/types/out/objects.d.ts:8235

Describes a transaction with payment for [paid broadcasting](https://core.telegram.org/bots/api#paid-broadcasts).

[Documentation](https://core.telegram.org/bots/api/#transactionpartnertelegramapi)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `request_count` | `number` | The number of successful requests that exceeded regular limits and were therefore billed | @gramio/types/out/objects.d.ts:8243 |
|  `type` | `"telegram_api"` | Type of the transaction partner, always “telegram\_api” | @gramio/types/out/objects.d.ts:8239 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramTransactionPartnerUser.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramTransactionPartnerUser

# Interface: TelegramTransactionPartnerUser

Defined in: @gramio/types/out/objects.d.ts:8119

Describes a transaction with a user.

[Documentation](https://core.telegram.org/bots/api/#transactionpartneruser)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `affiliate?` | [`TelegramAffiliateInfo`](TelegramAffiliateInfo.md) | *Optional*. Information about the affiliate that received a commission via this transaction. Can be available only for “invoice\_payment” and “paid\_media\_payment” transactions. | @gramio/types/out/objects.d.ts:8135 |
|  `gift?` | [`TelegramGift`](TelegramGift.md) | *Optional*. The gift sent to the user by the bot; for “gift\_purchase” transactions only | @gramio/types/out/objects.d.ts:8155 |
|  `invoice_payload?` | `string` | *Optional*. Bot-specified invoice payload. Can be available only for “invoice\_payment” transactions. | @gramio/types/out/objects.d.ts:8139 |
|  `paid_media?` | [`TelegramPaidMedia`](../type-aliases/TelegramPaidMedia.md)\[] | *Optional*. Information about the paid media bought by the user; for “paid\_media\_payment” transactions only | @gramio/types/out/objects.d.ts:8147 |
|  `paid_media_payload?` | `string` | *Optional*. Bot-specified paid media payload. Can be available only for “paid\_media\_payment” transactions. | @gramio/types/out/objects.d.ts:8151 |
|  `premium_subscription_duration?` | `number` | *Optional*. Number of months the gifted Telegram Premium subscription will be active for; for “premium\_purchase” transactions only | @gramio/types/out/objects.d.ts:8159 |
|  `subscription_period?` | `number` | *Optional*. The duration of the paid subscription. Can be available only for “invoice\_payment” transactions. | @gramio/types/out/objects.d.ts:8143 |
|  `transaction_type` | [`TelegramTransactionPartnerUserTransactionType`](../type-aliases/TelegramTransactionPartnerUserTransactionType.md) | Type of the transaction, currently one of “invoice\_payment” for payments via invoices, “paid\_media\_payment” for payments for paid media, “gift\_purchase” for gifts sent by the bot, “premium\_purchase” for Telegram Premium subscriptions gifted by the bot, “business\_account\_transfer” for direct transfers from managed business accounts | @gramio/types/out/objects.d.ts:8127 |
|  `type` | `"user"` | Type of the transaction partner, always “user” | @gramio/types/out/objects.d.ts:8123 |
|  `user` | [`TelegramUser`](TelegramUser.md) | Information about the user | @gramio/types/out/objects.d.ts:8131 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUniqueGift.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUniqueGift

# Interface: TelegramUniqueGift

Defined in: @gramio/types/out/objects.d.ts:4768

This object describes a unique gift that was upgraded from a regular gift.

[Documentation](https://core.telegram.org/bots/api/#uniquegift)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `backdrop` | [`TelegramUniqueGiftBackdrop`](TelegramUniqueGiftBackdrop.md) | Backdrop of the gift | @gramio/types/out/objects.d.ts:4796 |
|  `base_name` | `string` | Human-readable name of the regular gift from which this unique gift was upgraded | @gramio/types/out/objects.d.ts:4776 |
|  `colors?` | [`TelegramUniqueGiftColors`](TelegramUniqueGiftColors.md) | *Optional*. The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews; for business account gifts and gifts that are currently on sale only | @gramio/types/out/objects.d.ts:4812 |
|  `gift_id` | `string` | Identifier of the regular gift from which the gift was upgraded | @gramio/types/out/objects.d.ts:4772 |
|  `is_burned?` | `true` | *Optional*. *True*, if the gift was used to craft another gift and isn't available anymore | @gramio/types/out/objects.d.ts:4804 |
|  `is_from_blockchain?` | `true` | *Optional*. *True*, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram | @gramio/types/out/objects.d.ts:4808 |
|  `is_premium?` | `true` | *Optional*. *True*, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers | @gramio/types/out/objects.d.ts:4800 |
|  `model` | [`TelegramUniqueGiftModel`](TelegramUniqueGiftModel.md) | Model of the gift | @gramio/types/out/objects.d.ts:4788 |
|  `name` | `string` | Unique name of the gift. This name can be used in `https://t.me/nft/...` links and story areas | @gramio/types/out/objects.d.ts:4780 |
|  `number` | `number` | Unique number of the upgraded gift among gifts upgraded from the same regular gift | @gramio/types/out/objects.d.ts:4784 |
|  `publisher_chat?` | [`TelegramChat`](TelegramChat.md) | *Optional*. Information about the chat that published the gift | @gramio/types/out/objects.d.ts:4816 |
|  `symbol` | [`TelegramUniqueGiftSymbol`](TelegramUniqueGiftSymbol.md) | Symbol of the gift | @gramio/types/out/objects.d.ts:4792 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUniqueGiftBackdrop.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUniqueGiftBackdrop

# Interface: TelegramUniqueGiftBackdrop

Defined in: @gramio/types/out/objects.d.ts:4716

This object describes the backdrop of a unique gift.

[Documentation](https://core.telegram.org/bots/api/#uniquegiftbackdrop)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `colors` | [`TelegramUniqueGiftBackdropColors`](TelegramUniqueGiftBackdropColors.md) | Colors of the backdrop | @gramio/types/out/objects.d.ts:4724 |
|  `name` | `string` | Name of the backdrop | @gramio/types/out/objects.d.ts:4720 |
|  `rarity_per_mille` | `number` | The number of unique gifts that receive this backdrop for every 1000 gifts upgraded | @gramio/types/out/objects.d.ts:4728 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUniqueGiftBackdropColors.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUniqueGiftBackdropColors

# Interface: TelegramUniqueGiftBackdropColors

Defined in: @gramio/types/out/objects.d.ts:4692

This object describes the colors of the backdrop of a unique gift.

[Documentation](https://core.telegram.org/bots/api/#uniquegiftbackdropcolors)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `center_color` | `number` | The color in the center of the backdrop in RGB format | @gramio/types/out/objects.d.ts:4696 |
|  `edge_color` | `number` | The color on the edges of the backdrop in RGB format | @gramio/types/out/objects.d.ts:4700 |
|  `symbol_color` | `number` | The color to be applied to the symbol in RGB format | @gramio/types/out/objects.d.ts:4704 |
|  `text_color` | `number` | The color for the text on the backdrop in RGB format | @gramio/types/out/objects.d.ts:4708 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUniqueGiftColors.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUniqueGiftColors

# Interface: TelegramUniqueGiftColors

Defined in: @gramio/types/out/objects.d.ts:4736

This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.

[Documentation](https://core.telegram.org/bots/api/#uniquegiftcolors)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `dark_theme_main_color` | `number` | Main color used in dark themes; RGB format | @gramio/types/out/objects.d.ts:4756 |
|  `dark_theme_other_colors` | `number`\[] | List of 1-3 additional colors used in dark themes; RGB format | @gramio/types/out/objects.d.ts:4760 |
|  `light_theme_main_color` | `number` | Main color used in light themes; RGB format | @gramio/types/out/objects.d.ts:4748 |
|  `light_theme_other_colors` | `number`\[] | List of 1-3 additional colors used in light themes; RGB format | @gramio/types/out/objects.d.ts:4752 |
|  `model_custom_emoji_id` | `string` | Custom emoji identifier of the unique gift's model | @gramio/types/out/objects.d.ts:4740 |
|  `symbol_custom_emoji_id` | `string` | Custom emoji identifier of the unique gift's symbol | @gramio/types/out/objects.d.ts:4744 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUniqueGiftInfo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUniqueGiftInfo

# Interface: TelegramUniqueGiftInfo

Defined in: @gramio/types/out/objects.d.ts:4880

Describes a service message about a unique gift that was sent or received.

[Documentation](https://core.telegram.org/bots/api/#uniquegiftinfo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `gift` | [`TelegramUniqueGift`](TelegramUniqueGift.md) | Information about the gift | @gramio/types/out/objects.d.ts:4884 |
|  `last_resale_amount?` | `number` | *Optional*. For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins | @gramio/types/out/objects.d.ts:4896 |
|  `last_resale_currency?` | [`TelegramUniqueGiftInfoLastResaleCurrency`](../type-aliases/TelegramUniqueGiftInfoLastResaleCurrency.md) | *Optional*. For gifts bought from other users, the currency in which the payment for the gift was done. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins. | @gramio/types/out/objects.d.ts:4892 |
|  `next_transfer_date?` | `number` | *Optional*. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now | @gramio/types/out/objects.d.ts:4908 |
|  `origin` | [`TelegramUniqueGiftInfoOrigin`](../type-aliases/TelegramUniqueGiftInfoOrigin.md) | Origin of the gift. Currently, either “upgrade” for gifts upgraded from regular gifts, “transfer” for gifts transferred from other users or channels, “resale” for gifts bought from other users, “gifted\_upgrade” for upgrades purchased after the gift was sent, or “offer” for gifts bought or sold through gift purchase offers | @gramio/types/out/objects.d.ts:4888 |
|  `owned_gift_id?` | `string` | *Optional*. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts | @gramio/types/out/objects.d.ts:4900 |
|  `transfer_star_count?` | `number` | *Optional*. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift | @gramio/types/out/objects.d.ts:4904 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUniqueGiftModel.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUniqueGiftModel

# Interface: TelegramUniqueGiftModel

Defined in: @gramio/types/out/objects.d.ts:4648

This object describes the model of a unique gift.

[Documentation](https://core.telegram.org/bots/api/#uniquegiftmodel)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `name` | `string` | Name of the model | @gramio/types/out/objects.d.ts:4652 |
|  `rarity?` | [`TelegramUniqueGiftModelRarity`](../type-aliases/TelegramUniqueGiftModelRarity.md) | *Optional*. Rarity of the model if it is a crafted model. Currently, can be “uncommon”, “rare”, “epic”, or “legendary”. | @gramio/types/out/objects.d.ts:4664 |
|  `rarity_per_mille` | `number` | The number of unique gifts that receive this model for every 1000 gift upgrades. Always 0 for crafted gifts. | @gramio/types/out/objects.d.ts:4660 |
|  `sticker` | [`TelegramSticker`](TelegramSticker.md) | The sticker that represents the unique gift | @gramio/types/out/objects.d.ts:4656 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUniqueGiftSymbol.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUniqueGiftSymbol

# Interface: TelegramUniqueGiftSymbol

Defined in: @gramio/types/out/objects.d.ts:4672

This object describes the symbol shown on the pattern of a unique gift.

[Documentation](https://core.telegram.org/bots/api/#uniquegiftsymbol)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `name` | `string` | Name of the symbol | @gramio/types/out/objects.d.ts:4676 |
|  `rarity_per_mille` | `number` | The number of unique gifts that receive this model for every 1000 gifts upgraded | @gramio/types/out/objects.d.ts:4684 |
|  `sticker` | [`TelegramSticker`](TelegramSticker.md) | The sticker that represents the unique gift | @gramio/types/out/objects.d.ts:4680 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUpdate.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUpdate

# Interface: TelegramUpdate

Defined in: @gramio/types/out/objects.d.ts:25

This [object](https://core.telegram.org/bots/api#available-types) represents an incoming update.
At most **one** of the optional parameters can be present in any given update.

[Documentation](https://core.telegram.org/bots/api/#update)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection?` | [`TelegramBusinessConnection`](TelegramBusinessConnection.md) | *Optional*. The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot | @gramio/types/out/objects.d.ts:49 |
|  `business_message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. New message from a connected business account | @gramio/types/out/objects.d.ts:53 |
|  `callback_query?` | [`TelegramCallbackQuery`](TelegramCallbackQuery.md) | *Optional*. New incoming callback query | @gramio/types/out/objects.d.ts:81 |
|  `channel_post?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. New incoming channel post of any kind - text, photo, sticker, etc. | @gramio/types/out/objects.d.ts:41 |
|  `chat_boost?` | [`TelegramChatBoostUpdated`](TelegramChatBoostUpdated.md) | *Optional*. A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates. | @gramio/types/out/objects.d.ts:117 |
|  `chat_join_request?` | [`TelegramChatJoinRequest`](TelegramChatJoinRequest.md) | *Optional*. A request to join the chat has been sent. The bot must have the *can\_invite\_users* administrator right in the chat to receive these updates. | @gramio/types/out/objects.d.ts:113 |
|  `chat_member?` | [`TelegramChatMemberUpdated`](TelegramChatMemberUpdated.md) | *Optional*. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify `"chat_member"` in the list of *allowed\_updates* to receive these updates. | @gramio/types/out/objects.d.ts:109 |
|  `chosen_inline_result?` | [`TelegramChosenInlineResult`](TelegramChosenInlineResult.md) | *Optional*. The result of an [inline](https://core.telegram.org/bots/api#inline-mode) query that was chosen by a user and sent to their chat partner. Please see our documentation on the [feedback collecting](https://core.telegram.org/bots/inline#collecting-feedback) for details on how to enable these updates for your bot. | @gramio/types/out/objects.d.ts:77 |
|  `deleted_business_messages?` | [`TelegramBusinessMessagesDeleted`](TelegramBusinessMessagesDeleted.md) | *Optional*. Messages were deleted from a connected business account | @gramio/types/out/objects.d.ts:61 |
|  `edited_business_message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. New version of a message from a connected business account | @gramio/types/out/objects.d.ts:57 |
|  `edited_channel_post?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. New version of a channel post that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot. | @gramio/types/out/objects.d.ts:45 |
|  `edited_message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. New version of a message that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot. | @gramio/types/out/objects.d.ts:37 |
|  `inline_query?` | [`TelegramInlineQuery`](TelegramInlineQuery.md) | *Optional*. New incoming [inline](https://core.telegram.org/bots/api#inline-mode) query | @gramio/types/out/objects.d.ts:73 |
|  `message?` | [`TelegramMessage`](TelegramMessage.md) | *Optional*. New incoming message of any kind - text, photo, sticker, etc. | @gramio/types/out/objects.d.ts:33 |
|  `message_reaction?` | [`TelegramMessageReactionUpdated`](TelegramMessageReactionUpdated.md) | *Optional*. A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify `"message_reaction"` in the list of *allowed\_updates* to receive these updates. The update isn't received for reactions set by bots. | @gramio/types/out/objects.d.ts:65 |
|  `message_reaction_count?` | [`TelegramMessageReactionCountUpdated`](TelegramMessageReactionCountUpdated.md) | *Optional*. Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify `"message_reaction_count"` in the list of *allowed\_updates* to receive these updates. The updates are grouped and can be sent with delay up to a few minutes. | @gramio/types/out/objects.d.ts:69 |
|  `my_chat_member?` | [`TelegramChatMemberUpdated`](TelegramChatMemberUpdated.md) | *Optional*. The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user. | @gramio/types/out/objects.d.ts:105 |
|  `poll?` | [`TelegramPoll`](TelegramPoll.md) | *Optional*. New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot | @gramio/types/out/objects.d.ts:97 |
|  `poll_answer?` | [`TelegramPollAnswer`](TelegramPollAnswer.md) | *Optional*. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself. | @gramio/types/out/objects.d.ts:101 |
|  `pre_checkout_query?` | [`TelegramPreCheckoutQuery`](TelegramPreCheckoutQuery.md) | *Optional*. New incoming pre-checkout query. Contains full information about checkout | @gramio/types/out/objects.d.ts:89 |
|  `purchased_paid_media?` | [`TelegramPaidMediaPurchased`](TelegramPaidMediaPurchased.md) | *Optional*. A user purchased paid media with a non-empty payload sent by the bot in a non-channel chat | @gramio/types/out/objects.d.ts:93 |
|  `removed_chat_boost?` | [`TelegramChatBoostRemoved`](TelegramChatBoostRemoved.md) | *Optional*. A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates. | @gramio/types/out/objects.d.ts:121 |
|  `shipping_query?` | [`TelegramShippingQuery`](TelegramShippingQuery.md) | *Optional*. New incoming shipping query. Only for invoices with flexible price | @gramio/types/out/objects.d.ts:85 |
|  `update_id` | `number` | The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This identifier becomes especially handy if you're using [webhooks](https://core.telegram.org/bots/api#setwebhook), since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially. | @gramio/types/out/objects.d.ts:29 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUser.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUser

# Interface: TelegramUser

Defined in: @gramio/types/out/objects.d.ts:173

This object represents a Telegram user or bot.

[Documentation](https://core.telegram.org/bots/api/#user)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `added_to_attachment_menu?` | `true` | *Optional*. *True*, if this user added the bot to the attachment menu | @gramio/types/out/objects.d.ts:205 |
|  `allows_users_to_create_topics?` | `boolean` | *Optional*. *True*, if the bot allows users to create and delete topics in private chats. Returned only in [getMe](https://core.telegram.org/bots/api#getme). | @gramio/types/out/objects.d.ts:233 |
|  `can_connect_to_business?` | `boolean` | *Optional*. *True*, if the bot can be connected to a Telegram Business account to receive its messages. Returned only in [getMe](https://core.telegram.org/bots/api#getme). | @gramio/types/out/objects.d.ts:221 |
|  `can_join_groups?` | `boolean` | *Optional*. *True*, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api#getme). | @gramio/types/out/objects.d.ts:209 |
|  `can_read_all_group_messages?` | `boolean` | *Optional*. *True*, if [privacy mode](https://core.telegram.org/bots/features#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api#getme). | @gramio/types/out/objects.d.ts:213 |
|  `first_name` | `string` | User's or bot's first name | @gramio/types/out/objects.d.ts:185 |
|  `has_main_web_app?` | `boolean` | *Optional*. *True*, if the bot has a main Web App. Returned only in [getMe](https://core.telegram.org/bots/api#getme). | @gramio/types/out/objects.d.ts:225 |
|  `has_topics_enabled?` | `boolean` | *Optional*. *True*, if the bot has forum topic mode enabled in private chats. Returned only in [getMe](https://core.telegram.org/bots/api#getme). | @gramio/types/out/objects.d.ts:229 |
|  `id` | `number` | Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. | @gramio/types/out/objects.d.ts:177 |
|  `is_bot` | `boolean` | *True*, if this user is a bot | @gramio/types/out/objects.d.ts:181 |
|  `is_premium?` | `true` | *Optional*. *True*, if this user is a Telegram Premium user | @gramio/types/out/objects.d.ts:201 |
|  `language_code?` | `string` | *Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language | @gramio/types/out/objects.d.ts:197 |
|  `last_name?` | `string` | *Optional*. User's or bot's last name | @gramio/types/out/objects.d.ts:189 |
|  `supports_inline_queries?` | `boolean` | *Optional*. *True*, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api#getme). | @gramio/types/out/objects.d.ts:217 |
|  `username?` | `string` | *Optional*. User's or bot's username | @gramio/types/out/objects.d.ts:193 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUserChatBoosts.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUserChatBoosts

# Interface: TelegramUserChatBoosts

Defined in: @gramio/types/out/objects.d.ts:5498

This object represents a list of boosts added to a chat by a user.

[Documentation](https://core.telegram.org/bots/api/#userchatboosts)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `boosts` | [`TelegramChatBoost`](TelegramChatBoost.md)\[] | The list of boosts added to the chat by the user | @gramio/types/out/objects.d.ts:5502 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUserProfileAudios.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUserProfileAudios

# Interface: TelegramUserProfileAudios

Defined in: @gramio/types/out/objects.d.ts:2955

This object represents the audios displayed on a user's profile.

[Documentation](https://core.telegram.org/bots/api/#userprofileaudios)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `audios` | [`TelegramAudio`](TelegramAudio.md)\[] | Requested profile audios | @gramio/types/out/objects.d.ts:2963 |
|  `total_count` | `number` | Total number of profile audios for the target user | @gramio/types/out/objects.d.ts:2959 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUserProfilePhotos.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUserProfilePhotos

# Interface: TelegramUserProfilePhotos

Defined in: @gramio/types/out/objects.d.ts:2939

This object represent a user's profile pictures.

[Documentation](https://core.telegram.org/bots/api/#userprofilephotos)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `photos` | [`TelegramPhotoSize`](TelegramPhotoSize.md)\[]\[] | Requested profile pictures (in up to 4 sizes each) | @gramio/types/out/objects.d.ts:2947 |
|  `total_count` | `number` | Total number of profile pictures the target user has | @gramio/types/out/objects.d.ts:2943 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUserRating.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUserRating

# Interface: TelegramUserRating

Defined in: @gramio/types/out/objects.d.ts:4079

This object describes the rating of a user based on their Telegram Star spendings.

[Documentation](https://core.telegram.org/bots/api/#userrating)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `current_level_rating` | `number` | The rating value required to get the current level | @gramio/types/out/objects.d.ts:4091 |
|  `level` | `number` | Current level of the user, indicating their reliability when purchasing digital goods and services. A higher level suggests a more trustworthy customer; a negative level is likely reason for concern. | @gramio/types/out/objects.d.ts:4083 |
|  `next_level_rating?` | `number` | *Optional*. The rating value required to get to the next level; omitted if the maximum level was reached | @gramio/types/out/objects.d.ts:4095 |
|  `rating` | `number` | Numerical value of the user's rating; the higher the rating, the better | @gramio/types/out/objects.d.ts:4087 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramUsersShared.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUsersShared

# Interface: TelegramUsersShared

Defined in: @gramio/types/out/objects.d.ts:2469

This object contains information about the users whose identifiers were shared with the bot using a [KeyboardButtonRequestUsers](https://core.telegram.org/bots/api#keyboardbuttonrequestusers) button.

[Documentation](https://core.telegram.org/bots/api/#usersshared)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `request_id` | `number` | Identifier of the request | @gramio/types/out/objects.d.ts:2473 |
|  `users` | [`TelegramSharedUser`](TelegramSharedUser.md)\[] | Information about users shared with the bot. | @gramio/types/out/objects.d.ts:2477 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramVenue.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramVenue

# Interface: TelegramVenue

Defined in: @gramio/types/out/objects.d.ts:2083

This object represents a venue.

[Documentation](https://core.telegram.org/bots/api/#venue)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `address` | `string` | Address of the venue | @gramio/types/out/objects.d.ts:2095 |
|  `foursquare_id?` | `string` | *Optional*. Foursquare identifier of the venue | @gramio/types/out/objects.d.ts:2099 |
|  `foursquare_type?` | `string` | *Optional*. Foursquare type of the venue. (For example, “arts\_entertainment/default”, “arts\_entertainment/aquarium” or “food/icecream”.) | @gramio/types/out/objects.d.ts:2103 |
|  `google_place_id?` | `string` | *Optional*. Google Places identifier of the venue | @gramio/types/out/objects.d.ts:2107 |
|  `google_place_type?` | `string` | *Optional*. Google Places type of the venue. (See [supported types](https://developers.google.com/places/web-service/supported_types).) | @gramio/types/out/objects.d.ts:2111 |
|  `location` | [`TelegramLocation`](TelegramLocation.md) | Venue location. Can't be a live location | @gramio/types/out/objects.d.ts:2087 |
|  `title` | `string` | Name of the venue | @gramio/types/out/objects.d.ts:2091 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramVideo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramVideo

# Interface: TelegramVideo

Defined in: @gramio/types/out/objects.d.ts:1523

This object represents a video file.

[Documentation](https://core.telegram.org/bots/api/#video)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `cover?` | [`TelegramPhotoSize`](TelegramPhotoSize.md)\[] | *Optional*. Available sizes of the cover of the video in the message | @gramio/types/out/objects.d.ts:1551 |
|  `duration` | `number` | Duration of the video in seconds as defined by the sender | @gramio/types/out/objects.d.ts:1543 |
|  `file_id` | `string` | Identifier for this file, which can be used to download or reuse the file | @gramio/types/out/objects.d.ts:1527 |
|  `file_name?` | `string` | *Optional*. Original filename as defined by the sender | @gramio/types/out/objects.d.ts:1563 |
|  `file_size?` | `number` | *Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. | @gramio/types/out/objects.d.ts:1571 |
|  `file_unique_id` | `string` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:1531 |
|  `height` | `number` | Video height as defined by the sender | @gramio/types/out/objects.d.ts:1539 |
|  `mime_type?` | `string` | *Optional*. MIME type of the file as defined by the sender | @gramio/types/out/objects.d.ts:1567 |
|  `qualities?` | [`TelegramVideoQuality`](TelegramVideoQuality.md)\[] | *Optional*. List of available qualities of the video | @gramio/types/out/objects.d.ts:1559 |
|  `start_timestamp?` | `number` | *Optional*. Timestamp in seconds from which the video will play in the message | @gramio/types/out/objects.d.ts:1555 |
|  `thumbnail?` | [`TelegramPhotoSize`](TelegramPhotoSize.md) | *Optional*. Video thumbnail | @gramio/types/out/objects.d.ts:1547 |
|  `width` | `number` | Video width as defined by the sender | @gramio/types/out/objects.d.ts:1535 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramVideoChatEnded.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramVideoChatEnded

# Interface: TelegramVideoChatEnded

Defined in: @gramio/types/out/objects.d.ts:2552

This object represents a service message about a video chat ended in the chat.

[Documentation](https://core.telegram.org/bots/api/#videochatended)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `duration` | `number` | Video chat duration in seconds | @gramio/types/out/objects.d.ts:2556 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/TelegramVideoChatParticipantsInvited.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramVideoChatParticipantsInvited

# Interface: TelegramVideoChatParticipantsInvited

Defined in: @gramio/types/out/objects.d.ts:2564

This object represents a service message about new members invited to a video chat.

[Documentation](https://core.telegram.org/bots/api/#videochatparticipantsinvited)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `users` | [`TelegramUser`](TelegramUser.md)\[] | New members that were invited to the video chat | @gramio/types/out/objects.d.ts:2568 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramVideoChatScheduled.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramVideoChatScheduled

# Interface: TelegramVideoChatScheduled

Defined in: @gramio/types/out/objects.d.ts:2533

This object represents a service message about a video chat scheduled in the chat.

[Documentation](https://core.telegram.org/bots/api/#videochatscheduled)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `start_date` | `number` | Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator | @gramio/types/out/objects.d.ts:2537 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramVideoChatStarted.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramVideoChatStarted

# Interface: TelegramVideoChatStarted

Defined in: @gramio/types/out/objects.d.ts:2545

This object represents a service message about a video chat started in the chat. Currently holds no information.

[Documentation](https://core.telegram.org/bots/api/#videochatstarted)

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramVideoNote.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramVideoNote

# Interface: TelegramVideoNote

Defined in: @gramio/types/out/objects.d.ts:1579

This object represents a [video message](https://telegram.org/blog/video-messages-and-telescope) (available in Telegram apps as of [v.4.0](https://telegram.org/blog/video-messages-and-telescope)).

[Documentation](https://core.telegram.org/bots/api/#videonote)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `duration` | `number` | Duration of the video in seconds as defined by the sender | @gramio/types/out/objects.d.ts:1595 |
|  `file_id` | `string` | Identifier for this file, which can be used to download or reuse the file | @gramio/types/out/objects.d.ts:1583 |
|  `file_size?` | `number` | *Optional*. File size in bytes | @gramio/types/out/objects.d.ts:1603 |
|  `file_unique_id` | `string` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:1587 |
|  `length` | `number` | Video width and height (diameter of the video message) as defined by the sender | @gramio/types/out/objects.d.ts:1591 |
|  `thumbnail?` | [`TelegramPhotoSize`](TelegramPhotoSize.md) | *Optional*. Video thumbnail | @gramio/types/out/objects.d.ts:1599 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramVideoQuality.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramVideoQuality

# Interface: TelegramVideoQuality

Defined in: @gramio/types/out/objects.d.ts:1491

This object represents a video file of a specific quality.

[Documentation](https://core.telegram.org/bots/api/#videoquality)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `codec` | [`TelegramVideoQualityCodec`](../type-aliases/TelegramVideoQualityCodec.md) | Codec that was used to encode the video, for example, “h264”, “h265”, or “av01” | @gramio/types/out/objects.d.ts:1511 |
|  `file_id` | `string` | Identifier for this file, which can be used to download or reuse the file | @gramio/types/out/objects.d.ts:1495 |
|  `file_size?` | `number` | *Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. | @gramio/types/out/objects.d.ts:1515 |
|  `file_unique_id` | `string` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:1499 |
|  `height` | `number` | Video height | @gramio/types/out/objects.d.ts:1507 |
|  `width` | `number` | Video width | @gramio/types/out/objects.d.ts:1503 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramVoice.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramVoice

# Interface: TelegramVoice

Defined in: @gramio/types/out/objects.d.ts:1611

This object represents a voice note.

[Documentation](https://core.telegram.org/bots/api/#voice)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `duration` | `number` | Duration of the audio in seconds as defined by the sender | @gramio/types/out/objects.d.ts:1623 |
|  `file_id` | `string` | Identifier for this file, which can be used to download or reuse the file | @gramio/types/out/objects.d.ts:1615 |
|  `file_size?` | `number` | *Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. | @gramio/types/out/objects.d.ts:1631 |
|  `file_unique_id` | `string` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | @gramio/types/out/objects.d.ts:1619 |
|  `mime_type?` | `string` | *Optional*. MIME type of the file as defined by the sender | @gramio/types/out/objects.d.ts:1627 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramWebAppData.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramWebAppData

# Interface: TelegramWebAppData

Defined in: @gramio/types/out/objects.d.ts:2119

Describes data sent from a [Web App](https://core.telegram.org/bots/webapps) to the bot.

[Documentation](https://core.telegram.org/bots/api/#webappdata)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `button_text` | `string` | Text of the *web\_app* keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field. | @gramio/types/out/objects.d.ts:2127 |
|  `data` | `string` | The data. Be aware that a bad client can send arbitrary data in this field. | @gramio/types/out/objects.d.ts:2123 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramWebAppInfo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramWebAppInfo

# Interface: TelegramWebAppInfo

Defined in: @gramio/types/out/objects.d.ts:2997

Describes a [Web App](https://core.telegram.org/bots/webapps).

[Documentation](https://core.telegram.org/bots/api/#webappinfo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `url` | `string` | An HTTPS URL of a Web App to be opened with additional data as specified in [Initializing Web Apps](https://core.telegram.org/bots/webapps#initializing-mini-apps) | @gramio/types/out/objects.d.ts:3001 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramWebhookInfo.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramWebhookInfo

# Interface: TelegramWebhookInfo

Defined in: @gramio/types/out/objects.d.ts:129

Describes the current status of a webhook.

[Documentation](https://core.telegram.org/bots/api/#webhookinfo)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `allowed_updates?` | (`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"business_connection"` | `"business_message"` | `"edited_business_message"` | `"deleted_business_messages"` | `"message_reaction"` | `"message_reaction_count"` | `"inline_query"` | `"chosen_inline_result"` | `"callback_query"` | `"shipping_query"` | `"pre_checkout_query"` | `"purchased_paid_media"` | `"poll"` | `"poll_answer"` | `"my_chat_member"` | `"chat_member"` | `"chat_join_request"` | `"chat_boost"` | `"removed_chat_boost"`)\[] | *Optional*. A list of update types the bot is subscribed to. Defaults to all update types except *chat\_member* | @gramio/types/out/objects.d.ts:165 |
|  `has_custom_certificate` | `boolean` | *True*, if a custom certificate was provided for webhook certificate checks | @gramio/types/out/objects.d.ts:137 |
|  `ip_address?` | `string` | *Optional*. Currently used webhook IP address | @gramio/types/out/objects.d.ts:145 |
|  `last_error_date?` | `number` | *Optional*. Unix time for the most recent error that happened when trying to deliver an update via webhook | @gramio/types/out/objects.d.ts:149 |
|  `last_error_message?` | `string` | *Optional*. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook | @gramio/types/out/objects.d.ts:153 |
|  `last_synchronization_error_date?` | `number` | *Optional*. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters | @gramio/types/out/objects.d.ts:157 |
|  `max_connections?` | `number` | *Optional*. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery | @gramio/types/out/objects.d.ts:161 |
|  `pending_update_count` | `number` | Number of updates awaiting delivery | @gramio/types/out/objects.d.ts:141 |
|  `url` | `string` | Webhook URL, may be empty if webhook is not set up | @gramio/types/out/objects.d.ts:133 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TelegramWriteAccessAllowed.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramWriteAccessAllowed

# Interface: TelegramWriteAccessAllowed

Defined in: @gramio/types/out/objects.d.ts:2513

This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method [requestWriteAccess](https://core.telegram.org/bots/webapps#initializing-mini-apps).

[Documentation](https://core.telegram.org/bots/api/#writeaccessallowed)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `from_attachment_menu?` | `boolean` | *Optional*. *True*, if the access was granted when the bot was added to the attachment or side menu | @gramio/types/out/objects.d.ts:2525 |
|  `from_request?` | `boolean` | *Optional*. *True*, if the access was granted after the user accepted an explicit request from a Web App sent by the method [requestWriteAccess](https://core.telegram.org/bots/webapps#initializing-mini-apps) | @gramio/types/out/objects.d.ts:2517 |
|  `web_app_name?` | `string` | *Optional*. Name of the Web App, if the access was granted when the Web App was launched from a link | @gramio/types/out/objects.d.ts:2521 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TransferBusinessAccountStarsParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TransferBusinessAccountStarsParams

# Interface: TransferBusinessAccountStarsParams

Defined in: @gramio/types/out/params.d.ts:2931

Params object for [transferBusinessAccountStars](APIMethods.md#transferbusinessaccountstars) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:2935 |
|  `star_count` | `number` | Number of Telegram Stars to transfer; 1-10000 | @gramio/types/out/params.d.ts:2939 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/TransferGiftParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TransferGiftParams

# Interface: TransferGiftParams

Defined in: @gramio/types/out/params.d.ts:3123

Params object for [transferGift](APIMethods.md#transfergift) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:3127 |
|  `new_owner_chat_id` | `number` | Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours. | @gramio/types/out/params.d.ts:3135 |
|  `owned_gift_id` | `string` | Unique identifier of the regular gift that should be transferred | @gramio/types/out/params.d.ts:3131 |
|  `star_count?` | `number` | The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the *can\_transfer\_stars* business bot right is required. | @gramio/types/out/params.d.ts:3139 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/UnbanChatMemberParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / UnbanChatMemberParams

# Interface: UnbanChatMemberParams

Defined in: @gramio/types/out/params.d.ts:1743

Params object for [unbanChatMember](APIMethods.md#unbanchatmember) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target group or username of the target supergroup or channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1747 |
|  `only_if_banned?` | `boolean` | Do nothing if the user is not banned | @gramio/types/out/params.d.ts:1755 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:1751 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/UnbanChatSenderChatParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / UnbanChatSenderChatParams

# Interface: UnbanChatSenderChatParams

Defined in: @gramio/types/out/params.d.ts:1919

Params object for [unbanChatSenderChat](APIMethods.md#unbanchatsenderchat) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:1923 |
|  `sender_chat_id` | `number` | Unique identifier of the target sender chat | @gramio/types/out/params.d.ts:1927 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/UnhideGeneralForumTopicParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / UnhideGeneralForumTopicParams

# Interface: UnhideGeneralForumTopicParams

Defined in: @gramio/types/out/params.d.ts:2431

Params object for [unhideGeneralForumTopic](APIMethods.md#unhidegeneralforumtopic) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2435 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/UnpinAllChatMessagesParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / UnpinAllChatMessagesParams

# Interface: UnpinAllChatMessagesParams

Defined in: @gramio/types/out/params.d.ts:2191

Params object for [unpinAllChatMessages](APIMethods.md#unpinallchatmessages) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2195 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/UnpinAllForumTopicMessagesParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / UnpinAllForumTopicMessagesParams

# Interface: UnpinAllForumTopicMessagesParams

Defined in: @gramio/types/out/params.d.ts:2373

Params object for [unpinAllForumTopicMessages](APIMethods.md#unpinallforumtopicmessages) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2377 |
|  `message_thread_id` | `number` | Unique identifier for the target message thread of the forum topic | @gramio/types/out/params.d.ts:2381 |

---

---
url: >-
  https://gramio.dev/api/gramio/interfaces/UnpinAllGeneralForumTopicMessagesParams.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / UnpinAllGeneralForumTopicMessagesParams

# Interface: UnpinAllGeneralForumTopicMessagesParams

Defined in: @gramio/types/out/params.d.ts:2441

Params object for [unpinAllGeneralForumTopicMessages](APIMethods.md#unpinallgeneralforumtopicmessages) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) | @gramio/types/out/params.d.ts:2445 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/UnpinChatMessageParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / UnpinChatMessageParams

# Interface: UnpinChatMessageParams

Defined in: @gramio/types/out/params.d.ts:2173

Params object for [unpinChatMessage](APIMethods.md#unpinchatmessage) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id?` | `string` | Unique identifier of the business connection on behalf of which the message will be unpinned | @gramio/types/out/params.d.ts:2177 |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) | @gramio/types/out/params.d.ts:2181 |
|  `message_id?` | `number` | Identifier of the message to unpin. Required if *business\_connection\_id* is specified. If not specified, the most recent pinned message (by sending date) will be unpinned. | @gramio/types/out/params.d.ts:2185 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/UpgradeGiftParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / UpgradeGiftParams

# Interface: UpgradeGiftParams

Defined in: @gramio/types/out/params.d.ts:3101

Params object for [upgradeGift](APIMethods.md#upgradegift) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `business_connection_id` | `string` | Unique identifier of the business connection | @gramio/types/out/params.d.ts:3105 |
|  `keep_original_details?` | `boolean` | Pass *True* to keep the original gift text, sender and receiver in the upgraded gift | @gramio/types/out/params.d.ts:3113 |
|  `owned_gift_id` | `string` | Unique identifier of the regular gift that should be upgraded to a unique one | @gramio/types/out/params.d.ts:3109 |
|  `star_count?` | `number` | The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If `gift.prepaid_upgrade_star_count > 0`, then pass 0, otherwise, the *can\_transfer\_stars* business bot right is required and `gift.upgrade_star_count` must be passed. | @gramio/types/out/params.d.ts:3117 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/UploadStickerFileParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / UploadStickerFileParams

# Interface: UploadStickerFileParams

Defined in: @gramio/types/out/params.d.ts:3701

Params object for [uploadStickerFile](APIMethods.md#uploadstickerfile) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `sticker` | `Blob` | A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See <https://core.telegram.org/stickers> for technical requirements. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | @gramio/types/out/params.d.ts:3709 |
|  `sticker_format` | [`UploadStickerFileStickerFormat`](../type-aliases/UploadStickerFileStickerFormat.md) | Format of the sticker, must be one of “static”, “animated”, “video” | @gramio/types/out/params.d.ts:3713 |
|  `user_id` | `number` | User identifier of sticker file owner | @gramio/types/out/params.d.ts:3705 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/VerifyChatParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / VerifyChatParams

# Interface: VerifyChatParams

Defined in: @gramio/types/out/params.d.ts:2759

Params object for [verifyChat](APIMethods.md#verifychat) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `chat_id` | `string` | `number` | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`). Channel direct messages chats can't be verified. | @gramio/types/out/params.d.ts:2763 |
|  `custom_description?` | `string` | Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description. | @gramio/types/out/params.d.ts:2767 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/VerifyUserParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / VerifyUserParams

# Interface: VerifyUserParams

Defined in: @gramio/types/out/params.d.ts:2745

Params object for [verifyUser](APIMethods.md#verifyuser) method

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `custom_description?` | `string` | Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description. | @gramio/types/out/params.d.ts:2753 |
|  `user_id` | `number` | Unique identifier of the target user | @gramio/types/out/params.d.ts:2749 |

---

---
url: 'https://gramio.dev/api/prompt/interfaces/WaitFunction.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / WaitFunction

# Interface: WaitFunction()\<GlobalData>

Defined in: prompt/index.d.ts:107

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `GlobalData` | `never` |

## Call Signature

> **WaitFunction**<`Data`>(): `Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"`, `Data`>>

Defined in: prompt/index.d.ts:109

Wait for the next event from the user

### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Data` | `GlobalData` |

### Returns

`Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"`, `Data`>>

## Call Signature

> **WaitFunction**<`Event`, `Data`>(`event`): `Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`Event`, `Data`>>

Defined in: prompt/index.d.ts:111

Wait for the next event from the user ignoring events not listed

### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Event` *extends* `"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"` | - |
| `Data` | `GlobalData` |

### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | [`MaybeArray`](../type-aliases/MaybeArray.md)<`Event`> |

### Returns

`Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`Event`, `Data`>>

## Call Signature

> **WaitFunction**<`Data`>(`validate`): `Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"`, `Data`>>

Defined in: prompt/index.d.ts:113

Wait for the next event from the user ignoring non validated answers

### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Data` | `GlobalData` |

### Parameters

| Parameter | Type |
| ------ | ------ |
| `validate` | [`ValidateFunction`](../type-aliases/ValidateFunction.md)<`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"`> |

### Returns

`Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"`, `Data`>>

## Call Signature

> **WaitFunction**<`Event`, `Data`>(`event`, `options`): `Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`Event`, `Data`>>

Defined in: prompt/index.d.ts:115

Wait for the next event from the user ignoring non validated answers and not listed events with transformer

### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Event` *extends* `"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"` | - |
| `Data` | `GlobalData` |

### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | [`MaybeArray`](../type-aliases/MaybeArray.md)<`Event`> |
| `options` | { `transform?`: [`TransformFunction`](../type-aliases/TransformFunction.md)<`Event`, `Data`>; `validate?`: [`ValidateFunction`](../type-aliases/ValidateFunction.md)<`Event`>; } |
| `options.transform?` | [`TransformFunction`](../type-aliases/TransformFunction.md)<`Event`, `Data`> |
| `options.validate?` | [`ValidateFunction`](../type-aliases/ValidateFunction.md)<`Event`> |

### Returns

`Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`Event`, `Data`>>

## Call Signature

> **WaitFunction**<`Event`, `Data`>(`event`, `validate`): `Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`Event`, `Data`>>

Defined in: prompt/index.d.ts:120

Wait for the next event from the user ignoring non validated answers and not listed events

### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Event` *extends* `"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"` | - |
| `Data` | `GlobalData` |

### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | [`MaybeArray`](../type-aliases/MaybeArray.md)<`Event`> |
| `validate` | [`ValidateFunction`](../type-aliases/ValidateFunction.md)<`Event`> |

### Returns

`Promise`<[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`Event`, `Data`>>

---

---
url: 'https://gramio.dev/api/prompt/interfaces/WaitWithActionFunction.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / WaitWithActionFunction

# Interface: WaitWithActionFunction()\<GlobalData>

Defined in: prompt/index.d.ts:122

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `GlobalData` | `never` |

> **WaitWithActionFunction**<`Event`, `Data`, `ActionReturn`>(`event`, `action`, `validateOrOptions?`): `Promise`<\[[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`Event`, `Data`>, `ActionReturn`]>

Defined in: prompt/index.d.ts:123

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Event` *extends* `"message"` | `"edited_message"` | `"channel_post"` | `"edited_channel_post"` | `"callback_query"` | - |
| `Data` | `GlobalData` |
| `ActionReturn` | `any` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | [`MaybeArray`](../type-aliases/MaybeArray.md)<`Event`> |
| `action` | () => [`MaybePromise`](../../../../gramio/type-aliases/MaybePromise.md)<`ActionReturn`> |
| `validateOrOptions?` | [`ValidateFunction`](../type-aliases/ValidateFunction.md)<`Event`> | { `onValidateError?`: `string` | [`OnValidateErrorFunction`](../type-aliases/OnValidateErrorFunction.md)<`Event`, `Data`, `ActionReturn`>; `transform?`: [`TransformFunction`](../type-aliases/TransformFunction.md)<`Event`, `Data`>; `validate?`: [`ValidateFunction`](../type-aliases/ValidateFunction.md)<`Event`>; } |

## Returns

`Promise`<\[[`PromptAnswer`](../type-aliases/PromptAnswer.md)<`Event`, `Data`>, `ActionReturn`]>

---

---
url: 'https://gramio.dev/api/init-data/interfaces/WebAppChat.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/init-data/dist](../index.md) / WebAppChat

# Interface: WebAppChat

Defined in: init-data/index.d.ts:59

This object represents a chat.

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `id` | `number` | Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. | init-data/index.d.ts:63 |
|  `photo_url?` | `string` | URL of the chat’s photo. The photo can be in .jpeg or .svg formats. Only returned for Mini Apps launched from the attachment menu. | init-data/index.d.ts:80 |
|  `title` | `string` | Title of the chat. | init-data/index.d.ts:71 |
|  `type` | `"group"` | `"supergroup"` | `"channel"` | Type of the chat. | init-data/index.d.ts:67 |
|  `username?` | `string` | Username of the chat. | init-data/index.d.ts:75 |

---

---
url: 'https://gramio.dev/api/init-data/interfaces/WebAppInitData.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/init-data/dist](../index.md) / WebAppInitData

# Interface: WebAppInitData

Defined in: init-data/index.d.ts:85

This object contains data that is transferred to the Mini App when it is opened. It is empty if the Mini App was launched from a [keyboard button](https://core.telegram.org/bots/webapps#keyboard-button-mini-apps) or from [inline mode](https://core.telegram.org/bots/webapps#inline-mode-mini-apps).

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `auth_date` | `number` | Unix time when the form was opened. | init-data/index.d.ts:129 |
|  `can_send_after?` | `number` | Time in seconds, after which a message can be sent via the [answerWebAppQuery](https://core.telegram.org/bots/api#answerwebappquery) method. | init-data/index.d.ts:125 |
|  `chat?` | [`WebAppChat`](WebAppChat.md) | An object containing data about the chat where the bot was launched via the attachment menu. Returned for supergroups, channels and group chats – only for Mini Apps launched via the attachment menu. | init-data/index.d.ts:106 |
|  `chat_instance?` | `string` | A global identifier indicating the chat from which Mini App was opened. Returned only for applications opened by direct link. | init-data/index.d.ts:115 |
|  `chat_type?` | [`WebAppChatType`](../type-aliases/WebAppChatType.md) | Type of the chat from which the Mini App was opened. | init-data/index.d.ts:110 |
|  `hash` | `string` | A hash of all passed parameters, which the bot server can use to check their [validity](https://core.telegram.org/bots/webapps#validating-data-received-via-the-web-app). | init-data/index.d.ts:134 |
|  `query_id?` | `string` | A unique identifier for the Mini App session, required for sending messages via the [answerWebAppQuery](https://core.telegram.org/bots/api#answerwebappquery) method. | init-data/index.d.ts:90 |
|  `receiver?` | [`WebAppUser`](../type-aliases/WebAppUser.md)<`true`> | An object containing data about the chat partner of the current user in the chat where the bot was launched via the attachment menu. Returned only for private chats and only for Mini Apps launched via the attachment menu. | init-data/index.d.ts:101 |
|  `start_param?` | `string` | The value of the `startattach` parameter, passed [via link](https://core.telegram.org/bots/webapps#adding-bots-to-the-attachment-menu). Only returned for Mini Apps when launched from the attachment menu via link. The value of the `start_param` parameter will also be passed in the GET-parameter `tgWebAppStartParam`, so the Mini App can load the correct interface right away. | init-data/index.d.ts:121 |
|  `user?` | [`WebAppUser`](../type-aliases/WebAppUser.md) | An object containing data about the current user. | init-data/index.d.ts:94 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/WebhookHandlerOptions.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / WebhookHandlerOptions

# Interface: WebhookHandlerOptions

Defined in: gramio/index.d.ts:1677

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `secretToken?` | `string` | gramio/index.d.ts:1678 |
|  `shouldWait?` | `boolean` | [`WebhookHandlerOptionsShouldWait`](WebhookHandlerOptionsShouldWait.md) | gramio/index.d.ts:1679 |

---

---
url: 'https://gramio.dev/api/gramio/interfaces/WebhookHandlerOptionsShouldWait.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / WebhookHandlerOptionsShouldWait

# Interface: WebhookHandlerOptionsShouldWait

Defined in: gramio/index.d.ts:1671

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
|  `onTimeout?` | `"throw"` | `"return"` | Action to take when timeout occurs. **Default** `"throw"` | gramio/index.d.ts:1673 |
|  `timeout?` | `number` | Timeout in milliseconds. **Default** `10_000` | gramio/index.d.ts:1675 |

---

---
url: 'https://gramio.dev/guides/for-beginners/1.md'
---

# Introduction

## Who is this material for?

This material is designed for beginners in programming and Telegram bot development.

You need:

* JavaScript knowledge and at least a basic understanding of TypeScript (not required for the beginning of the guide)
* Installed [Node.js](https://nodejs.org/en) (v20.x versions)
* Ability to search for information online
* Telegram account (🤯)

---

---
url: 'https://gramio.dev/plugins/official/jsx.md'
---

# JSX

[![npm](https://img.shields.io/npm/v/@gramio/jsx?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/jsx)
[![JSR](https://jsr.io/badges/@gramio/jsx)](https://jsr.io/@gramio/jsx)
[![JSR Score](https://jsr.io/badges/@gramio/jsx/score)](https://jsr.io/@gramio/jsx)

Use **JSX** to format Telegram bot messages and build keyboards. Instead of chaining `format`, `bold`, `italic` functions, write familiar HTML-like syntax that compiles into GramIO's `FormattableString` and `InlineKeyboard`/`Keyboard` objects.

No React dependency required — the package provides its own JSX runtime.

## Installation

::: pm-add @gramio/jsx
:::

## Configuration

Add the JSX runtime to your `tsconfig.json`:

```json
{
    "compilerOptions": {
        "jsx": "react-jsx",
        "jsxImportSource": "@gramio/jsx"
    }
}
```

Your files should use the `.tsx` extension.

## Usage

### Text formatting

```tsx
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN!)
    .command("start", (context) =>
        context.send(<b>Hello!</b>)
    );

bot.start();
```

All Telegram formatting entities are supported as JSX elements:

```tsx
await context.send(
    <>
        <b>Bold text</b><br />
        <i>Italic text</i><br />
        <u>Underlined text</u><br />
        <s>Strikethrough</s><br />
        <spoiler>Hidden text</spoiler><br />
        <code>inline code</code><br />
        <pre>{`code block
with multiple lines`}</pre><br />
        <blockquote>Simple blockquote</blockquote><br />
        <blockquote expandable>Expandable blockquote</blockquote><br />
        <a href="https://gramio.dev">GramIO</a><br />
        <mention id={123456789}>User</mention><br />
        <custom-emoji emojiId="5222106016283378623">emoji</custom-emoji>
    </>
);
```

### Formatting elements reference

| Element | Description | Example |
|---------|-------------|---------|
| `<b>` | **Bold** text | `<b>bold</b>` |
| `<i>` | *Italic* text | `<i>italic</i>` |
| `<u>` | Underlined text | `<u>underline</u>` |
| `<s>` | ~~Strikethrough~~ text | `<s>strikethrough</s>` |
| `<spoiler>` | Spoiler (hidden) text | `<spoiler>hidden</spoiler>` |
| `<code>` | Inline code | `<code>code</code>` |
| `<pre>` | Code block | `<pre>code block</pre>` |
| `<blockquote>` | Blockquote | `<blockquote>quote</blockquote>` |
| `<a href="...">` | Hyperlink | `<a href="https://gramio.dev">link</a>` |
| `<mention id={...}>` | User mention by ID | `<mention id={123}>user</mention>` |
| `<custom-emoji emojiId="...">` | Custom emoji | `<custom-emoji emojiId="123">emoji</custom-emoji>` |
| `<br />` | Line break | `text<br />next line` |

The `<blockquote>` element supports an optional `expandable` boolean prop for expandable blockquotes.

Nesting is supported — for example, `<b><i>bold italic</i></b>`.

### Inline keyboard

Pass a `<keyboard inline>` element to `reply_markup`:

```tsx
await context.send(
    <b>Choose an option:</b>,
    {
        reply_markup: (
            <keyboard inline>
                <row>
                    <button callbackData="action1">Click me</button>
                    <button url="https://gramio.dev">Open link</button>
                </row>
                <row>
                    <button switchToCurrentChat="query">Inline search</button>
                </row>
            </keyboard>
        ),
    }
);
```

#### Inline button props

| Prop | Type | Description |
|------|------|-------------|
| `callbackData` | `string` | Callback data for button press |
| `url` | `string` | URL to open |
| `webApp` | `{ url: string }` | WebApp to open |
| `loginUrl` | `TelegramLoginUrl` | Login URL |
| `switchToChat` | `string` | Switch inline query to another chat |
| `switchToCurrentChat` | `string` | Switch inline query to current chat |
| `switchToChosenChat` | `string \| TelegramSwitchInlineQueryChosenChat` | Switch to chosen chat |
| `copyText` | `string` | Copy text to clipboard |
| `game` | `TelegramCallbackGame` | Callback game |

### Reply keyboard

Omit the `inline` prop on `<keyboard>`:

```tsx
await context.send("Choose an option:", {
    reply_markup: (
        <keyboard oneTime placeholder="Select...">
            <row>
                <button requestContact>Send contact</button>
                <button requestLocation>Send location</button>
            </row>
            <row>
                <button>Simple button</button>
            </row>
        </keyboard>
    ),
});
```

#### Reply keyboard props

| Prop | Type | Description |
|------|------|-------------|
| `persistent` | `boolean` | Always show the keyboard |
| `selective` | `boolean` | Show only to specific users |
| `resized` | `boolean` | Resize the keyboard to fit |
| `oneTime` | `boolean` | Hide after button press |
| `placeholder` | `string` | Input field placeholder |

#### Reply button props

| Prop | Type | Description |
|------|------|-------------|
| `requestContact` | `boolean` | Request user's phone contact |
| `requestLocation` | `boolean` | Request user's location |
| `requestChat` | `TelegramKeyboardButtonRequestChat` | Request a chat selection |
| `requestPoll` | `{ type: "quiz" \| "regular" }` | Request poll creation |
| `webApp` | `{ url: string }` | Open a WebApp |

## Full example

```tsx
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN!)
    .command("start", (context) =>
        context.send(<b>Hello!</b>)
    )
    .command("demo", async (context) => {
        await context.reply(
            <>
                <b>Bold text</b><br />
                <i>Italic text</i><br />
                <u>Underlined</u><br />
                <s>Strikethrough</s><br />
                <spoiler><b>Bold spoiler</b></spoiler><br />
                <a href="https://gramio.dev">GramIO</a><br />
                <mention id={context.from!.id}>You</mention><br />
                <code>print("Hello")</code><br />
                <pre>{`function greet() {
    console.log("Hello!");
}`}</pre>
            </>,
            {
                reply_markup: (
                    <keyboard inline>
                        <row>
                            <button callbackData="test">Click me</button>
                            <button url="https://gramio.dev">Docs</button>
                        </row>
                    </keyboard>
                ),
            }
        );
    })
    .onStart(console.log);

bot.start();
```

---

---
url: 'https://gramio.dev/keyboards/overview.md'
---

# Overview

[`@gramio/keyboards`](https://github.com/gramiojs/keyboards) is built-in GramIO package. You can also use it outside of this framework because it is framework-agnostic.

See also [API Reference](https://jsr.io/@gramio/keyboards/doc).

### Installation (not required for GramIO users)

::: pm-add @gramio/keyboards
:::

## Usage

::: code-group

```ts twoslash [with GramIO]
import { Keyboard } from "gramio";

const keyboard = new Keyboard().text("first row").row().text("second row");
```

```ts twoslash [without GramIO]
import { Keyboard } from "@gramio/keyboards";

const keyboard = new Keyboard()
    .text("first row")
    .row()
    .text("second row")
    .build();
```

:::

### Send via [GramIO](https://gramio.dev/)

```ts
import { Bot, Keyboard } from "gramio"; // import from GramIO package!!

const bot = new Bot(process.env.BOT_TOKEN as string);

const data = ["Apple", "Realme", "Tesla", "Xiaomi"];

bot.on("message", (ctx) => {
    return ctx.send("test", {
        reply_markup: new Keyboard()
            .columns(1)
            .text("simple keyboard")
            .add(...data.map((x) => Keyboard.text(x)))
            .filter(({ button }) => button.text !== "Tesla"),
    });
});

bot.start();
```

### Send via [Grammy](https://grammy.dev/)

```ts
import { Keyboard } from "@gramio/keyboards";
import { Bot } from "grammy";

const bot = new Bot(process.env.BOT_TOKEN as string);

const data = ["Apple", "Realme", "Tesla", "Xiaomi"];

bot.on("message", (ctx) => {
    return ctx.reply("test", {
        reply_markup: new Keyboard()
            .columns(1)
            .text("simple keyboard")
            .add(...data.map((x) => Keyboard.text(x)))
            .filter(({ button }) => button.text !== "Tesla")
            .build(),
    });
});

bot.start();
```

### Send via [Telegraf](https://github.com/telegraf/telegraf)

> \[!WARNING]
> The `Telegraf` does not support the latest version of Bot API

```ts
import { Keyboard } from "@gramio/keyboards";
import { Telegraf } from "telegraf";

const bot = new Telegraf(process.env.BOT_TOKEN as string);

const data = ["Apple", "Realme", "Tesla", "Xiaomi"];

bot.on("message", (ctx) => {
    return ctx.reply("test", {
        reply_markup: new Keyboard()
            .columns(1)
            .text("simple keyboard")
            .add(...data.map((x) => Keyboard.text(x)))
            .filter(({ button }) => button.text !== "Tesla")
            .build(),
    });
});

bot.launch();
```

### Send via [node-telegram-bot-api](https://www.npmjs.com/package/node-telegram-bot-api)

> \[!WARNING]
> The `node-telegram-bot-api` does not support the latest version of Bot API and the types are badly written, so the types may not match

```ts
import { Keyboard } from "@gramio/keyboards";
import TelegramBot from "node-telegram-bot-api";

const bot = new TelegramBot(process.env.TOKEN as string, { polling: true });

const data = ["Apple", "Realme", "Tesla", "Xiaomi"];

bot.on("message", (msg) => {
    return bot.sendMessage(msg.chat.id, "test", {
        reply_markup: new Keyboard()
            .columns(1)
            .text("simple keyboard")
            .add(...data.map((x) => Keyboard.text(x)))
            .filter(({ button }) => button.text !== "Tesla")
            .build(),
    });
});
```

### Send via [puregram](https://puregram.cool/)

> \[!WARNING]
> The `puregram` does not support the latest version of Bot API

```ts
import { Telegram } from "puregram";
import { Keyboard } from "@gramio/keyboards";

const bot = new Telegram({
    token: process.env.TOKEN as string,
});

const data = ["Apple", "Realme", "Tesla", "Xiaomi"];

bot.on("message", (ctx) => {
    return ctx.send("test", {
        reply_markup: new Keyboard()
            .columns(1)
            .text("simple keyboard")
            .add(...data.map((x) => Keyboard.text(x)))
            .filter(({ button }) => button.text !== "Tesla")
            .build(),
    });
});

bot.updates.startPolling();
```

#### Result

```json
{
    "keyboard": [
        [
            {
                "text": "simple keyboard"
            }
        ],
        [
            {
                "text": "Apple"
            }
        ],
        [
            {
                "text": "Realme"
            }
        ],
        [
            {
                "text": "Xiaomi"
            }
        ]
    ],
    "one_time_keyboard": false,
    "is_persistent": false,
    "selective": false,
    "resize_keyboard": true
}
```

![image](https://github.com/gramiojs/keyboards/assets/57632712/e65e2b0a-40f0-43ae-9887-04360e6dbeab)

---

---
url: 'https://gramio.dev/plugins/lazy-load.md'
---

# Lazy-Loading Plugins

Plugins can be **lazy-loaded** if they are in an **asynchronous** function. Such plugins are always connected at the very **last** moment (during the **.start** call). If you want to call it **earlier**, put **await** in front of it.

## Example

```ts
const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(autoload()) // autoload is async
    .command("start", () => {
        // this command registered BEFORE than autoload
    });

bot.start(); // autoload is loaded here
```

You can fix that with **await**.

```ts
const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(await autoload()) // autoload is async but we await it
    .command("start", () => {
        // this command registered AFTER than autoload
    });

bot.start();
```

for now it works as expected!

---

---
url: 'https://gramio.dev/updates/webhook.md'
---

# Long Polling vs Webhook

Telegram Bot API provides two ways for your bot to receive updates: **long polling** and **webhook**. Each approach has distinct trade-offs for development, performance, and scalability.

## How Long Polling Works

With long polling, your bot continuously calls the [`getUpdates`](https://core.telegram.org/bots/api#getupdates) method in a loop. Telegram holds the connection open until new updates are available (or a timeout is reached), then responds with them.

```
Bot                         Telegram
 │── getUpdates ──────────────►│
 │                             │ (waits for updates...)
 │◄─────────── [update] ───────│
 │── getUpdates ──────────────►│
 │                             │ (waits...)
 │◄─────────── [] ─────────────│  ← no updates
 │── getUpdates ──────────────►│
 ...
```

* Your bot initiates every request — Telegram never contacts your bot directly
* The `timeout` parameter controls how long Telegram holds the connection (default: 30, recommended: 25–30 seconds)
* No public URL or SSL certificate required
* Simple to run locally — just start the bot

In GramIO, long polling is the default behavior:

```ts
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string);

bot.on("message", (context) => {
    return context.send("Hello!");
});

bot.start(); // ← uses long polling by default
```

## How Webhook Works

With webhook, you register an HTTPS URL with Telegram. When an update arrives, Telegram sends an HTTP POST request to that URL with the update payload.

```
Bot                         Telegram
 │                             │
 │    (idle — no traffic)      │
 │                             │
 │                             │ ← user sends message
 │◄──── POST /webhook ────────│
 │── 200 OK ──────────────────►│
 │                             │
 │    (idle — no traffic)      │
```

* Telegram pushes updates to your bot — no polling loop needed
* Requires a publicly accessible HTTPS URL with a valid SSL certificate
* Lower latency — updates arrive instantly, no waiting for the next poll cycle
* More efficient — no traffic when there are no updates

## Which to Choose?

### Development — Long Polling

Long polling is ideal for local development:

* **No domain or SSL needed** — works on `localhost` out of the box
* **Zero configuration** — just call `bot.start()`
* **Easy debugging** — restart the bot instantly, no tunnel setup
* **Firewall-friendly** — outbound connections only, no incoming ports to open

### Production — Webhook

Webhook is the recommended choice for production deployments:

* **Lower latency** — updates are pushed instantly, no poll interval delay
* **No idle connections** — no resources wasted when there are no updates
* **Horizontal scaling** — multiple server instances behind a load balancer
* **Serverless compatible** — works with Vercel, AWS Lambda, Cloudflare Workers, and similar platforms
* **Resource efficiency** — no background polling loop consuming CPU and memory

## Multiple Pods & Scaling

This is where the choice becomes critical.

### Long Polling: Single Instance Only

Telegram **rejects** concurrent `getUpdates` calls from the same bot token. If two processes poll at the same time, one gets a `409 Conflict` error. This means:

* You can only run **one** polling instance
* No horizontal scaling
* No Kubernetes replicas, no Docker Swarm services with `replicas > 1`
* If that single process crashes, updates are delayed until it restarts

### Webhook: Scale Horizontally

With webhook, Telegram sends updates to a **URL** — it doesn't care how many servers are behind it. This unlocks:

```
                  ┌─── Pod 1 (bot) ◄──┐
Telegram ──POST──►│ Load Balancer      │
                  ├─── Pod 2 (bot) ◄──┤
                  └─── Pod 3 (bot) ◄──┘
```

* **Load balancer** distributes incoming requests across pods
* Each pod processes a subset of updates independently
* Auto-scaling works naturally — add more pods as load increases
* Healthier deployments — zero-downtime rolling updates

> \[!WARNING]
> When scaling with webhook, ensure your bot logic is stateless (or uses shared storage like Redis for sessions). Each update may arrive at a different pod.

## Comparison Table

| Feature | Long Polling | Webhook |
|---|---|---|
| Setup complexity | Minimal | Requires HTTPS URL + SSL |
| Public URL needed | No | Yes |
| Latency | Poll interval dependent | Instant push |
| Idle resource usage | Constant (polling loop) | Zero |
| Horizontal scaling | No (single instance) | Yes (load balancer) |
| Serverless support | No | Yes |
| Local development | Easy | Requires tunnel |
| Firewall issues | None (outbound only) | Must allow inbound HTTPS |

## Webhook Setup in GramIO

### Supported frameworks

* [Elysia](https://elysiajs.com/)
* [Fastify](https://fastify.dev/)
* [Hono](https://hono.dev/)
* [Express](https://expressjs.com/)
* [Koa](https://koajs.com/)
* [node:http](https://nodejs.org/api/http.html)
* [Bun.serve](https://bun.sh/docs/api/http)
* [std/http (Deno.serve)](https://docs.deno.com/runtime/manual/runtime/http_server_apis#http-server-apis)
* [And any other framework](#write-you-own-updates-handler)

### Example

```ts
import { Bot, webhookHandler } from "gramio";
import Fastify from "fastify";

const bot = new Bot(process.env.BOT_TOKEN as string);
const fastify = Fastify();

fastify.post("/telegram-webhook", webhookHandler(bot, "fastify"));

fastify.listen({ port: 3445, host: "::" });

bot.on("message", (context) => {
    return context.send("Fastify!");
});

bot.start({
    webhook: {
        url: "https://example.com:3445/telegram-webhook",
    },
});
```

### Use webhook only in production

Instead of use a tunnels, you can just use polling in development environment!

```ts
const bot = new Bot(process.env.BOT_TOKEN);

await bot.start({
    webhook:
        process.env.NODE_ENV === "production"
            ? {
                  url: `${process.env.API_URL}/${process.env.BOT_TOKEN}`,
              }
            : undefined,
});
```

When `webhook` is `undefined`, GramIO falls back to long polling automatically.

### Local development with webhook

For local development with webhook, we recommend using&#x20;
unjs/untun.

**Untun** is a tool for tunnel your **local** HTTP(s) server to the world!

> \[!IMPORTANT]
> Examples of starting with a specific framework are omitted. See [this example](#example).

#### via API

This method allows you to set a link to our tunnel directly in the script.

Install package:

::: pm-add untun
:::

Start tunnel and set webhook:

```ts
import { startTunnel } from "untun";

const tunnel = await startTunnel({ port: 3000 });

bot.start({
    webhook: {
        url: await tunnel.getURL(),
    },
});
```

#### via CLI

We are listening to port `3000` locally. Therefore, we open the tunnel like this:

```bash
◐ Starting cloudflared tunnel to http://localhost:3000
ℹ Waiting for tunnel URL...
✔ Tunnel ready at https://unjs-is-awesome.trycloudflare.com
```

Now we use this link when installing the webhook:

```ts
bot.start({
    webhook: {
        url: "https://unjs-is-awesome.trycloudflare.com",
    },
});
```

### Write you own updates handler

```ts
// a non-existing framework for the example
import { App } from "some-http-framework";
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string).on("message", (context) =>
    context.send("Hello!")
);

// init is required. It is used for lazy-load plugins, and also receives information about the bot.
await bot.init();

const app = new App().post("/telegram", async (req) => {
    // req.body must be json equivalent to TelegramUpdate
    await bot.updates.handleUpdate(req.body);
});

app.listen(80);
```

---

---
url: 'https://gramio.dev/plugins/official/media-cache.md'
---

# Media cache plugin

[![npm](https://img.shields.io/npm/v/@gramio/media-cache?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/media-cache)
[![JSR](https://jsr.io/badges/@gramio/media-cache)](https://jsr.io/@gramio/media-cache)
[![JSR Score](https://jsr.io/badges/@gramio/media-cache/score)](https://jsr.io/@gramio/media-cache)

`Media cache` plugin for [GramIO](https://gramio.dev/).

This plugin caches the sent `file_id`'s and prevents files from being uploaded again.

Currently, **sendMediaGroup** is not cached.

## Usage

```ts
import { Bot } from "gramio";
import { mediaCache } from "@gramio/media-cache";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(mediaCache())
    .command("start", async (context) => {
        return context.sendDocument(
            await MediaUpload.url(
                "https://raw.githubusercontent.com/gramiojs/types/main/README.md"
            )
        );
    })
    .onStart(console.log);

bot.start();
```

---

---
url: 'https://gramio.dev/plugins/official/media-group.md'
---

# Media group plugin

[![npm](https://img.shields.io/npm/v/@gramio/media-group?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/media-group)
[![JSR](https://jsr.io/badges/@gramio/media-group)](https://jsr.io/@gramio/media-group)
[![JSR Score](https://jsr.io/badges/@gramio/media-group/score)](https://jsr.io/@gramio/media-group)

This plugin collects `mediaGroup` from messages (**1** attachment = **1** message) using a **delay** if `mediaGroupId` is in the **MessageContext**, pass only **first** message further down the middleware chain with the `mediaGroup` key, which contains an **array** of messages of this **mediaGroup** (it also contains the **first** message).

```ts
import { Bot } from "gramio";
import { mediaGroup } from "@gramio/media-group";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(mediaGroup())
    .on("message", async (context) => {
        if (!context.mediaGroup) return;

        return context.send(
            `Caption from the first message - ${context.caption}. MediaGroup contains ${context.mediaGroup.length} attachments`
        );
    })
    .onStart(({ info }) => console.log(`✨ Bot ${info.username} was started!`));

bot.start();
```

### Installation

::: pm-add @gramio/media-group
:::

### Setup

You can change the duration of the delay in milliseconds by simply passing it like this:

```typescript
const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(mediaGroup(1000)) // wait 1 second for message with mediaGroupId (refreshed after new message with it)
    .on("message", async (context) => {
        if (!context.mediaGroup) return;

        return context.send(
            `Caption from the first message - ${context.caption}. MediaGroup contains ${context.mediaGroup.length} attachments`
        );
    })
    .onStart(({ info }) => console.log(`✨ Bot ${info.username} was started!`));

bot.start();
```

By default it `150 ms`.

---

---
url: 'https://gramio.dev/files/media-input.md'
---

# Media Input

Class-helper with static methods that represents the content of a media message to be sent.

[API Reference](https://jsr.io/@gramio/files/doc)

[Documentation](https://core.telegram.org/bots/api/#inputmedia)

## document

Represents a general file to be sent.

```ts twoslash
// @errors: 2345
import { BotLike, MessageContext } from "gramio";
import { MediaInput, MediaUpload } from "@gramio/files";

const ctx = {} as InstanceType<MessageContext<BotLike>>;
// ---cut---
// ctx from bot.on("message", (ctx) => ...)
ctx.sendMediaGroup([
    MediaInput.document(
        await MediaUpload.url(
            "https://raw.githubusercontent.com/gramiojs/types/main/README.md"
        )
    ),
    MediaInput.document(await MediaUpload.path("./package.json")),
]);
```

[Documentation](https://core.telegram.org/bots/api/#inputmediadocument)

## audio

Represents an audio file to be treated as music to be sent.

```ts twoslash
// @errors: 2345
import { BotLike, MessageContext } from "gramio";
import { MediaInput, MediaUpload } from "@gramio/files";

const ctx = {} as InstanceType<MessageContext<BotLike>>;
// ---cut---

// ctx from bot.on("message", (ctx) => ...)
ctx.sendMediaGroup([
    MediaInput.audio(await MediaUpload.url("https://.../music.mp3")),
    MediaInput.audio(await MediaUpload.path("./music.mp3")),
]);
```

[Documentation](https://core.telegram.org/bots/api/#inputmediaaudio)

## photo

Represents a photo to be sent.

```ts twoslash
// @errors: 2345
import { BotLike, MessageContext } from "gramio";
import { MediaInput, MediaUpload } from "@gramio/files";

const ctx = {} as InstanceType<MessageContext<BotLike>>;
// ---cut---
// ctx from bot.on("message", (ctx) => ...)
ctx.sendMediaGroup([
    MediaInput.photo(
        await MediaUpload.url(
            "https://w7.pngwing.com/pngs/140/552/png-transparent-kitten-if-cats-could-talk-the-meaning-of-meow-pet-sitting-dog-pet-dog-mammal-animals-cat-like-mammal.png"
        ),
        { has_spoiler: true, caption: "MaybeCat<TelegramInputFile>" }
    ),
    MediaInput.photo(await MediaUpload.path("./no-cat.png")),
]);
```

[Documentation](https://core.telegram.org/bots/api/#inputmediaphoto)

## video

Represents a video to be sent.

```ts twoslash
// @noErrors
import { BotLike, MessageContext } from "gramio";
import { MediaInput, MediaUpload } from "@gramio/files";

const ctx = {} as InstanceType<MessageContext<BotLike>>;
// ---cut---
// ctx from bot.on("message", (ctx) => ...)
ctx.sendMediaGroup([
    MediaInput.video(await MediaUpload.url("https://.../video.mp4"), {
        has_spoiler: true,
        thumbnail: MediaUpload.buffer(/**file buffer */),
    }),
    MediaInput.photo(await MediaUpload.path("./cat-walk.mp4")),
]);
```

[Documentation](https://core.telegram.org/bots/api/#inputmediavideo)

## animation

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

```ts twoslash
// @noErrors
import { MediaInput, MediaUpload } from "@gramio/files";
// ---cut---
MediaInput.animation(
    await MediaUpload.url(
        "https://media1.tenor.com/m/47qpxBq_Tw0AAAAd/cat-cat-meme.gif"
    )
);
```

[Documentation](https://core.telegram.org/bots/api/#inputmediaanimation)

---

---
url: 'https://gramio.dev/triggers/hears.md'
---

# Hears

The `hears` method in GramIO allows you to set up responses to specific messages. You can define what messages your bot should listen for and how it should handle when those messages are detected. The method is flexible and can work with regular expressions, exact strings, or custom functions.

## Basic Usage

### Using a `Regular Expression` matcher

You can make your bot listen for messages that match a specific pattern using regular expressions. This is useful when you want your bot to respond to messages that follow a certain structure.

```ts
bot.hears(/hello (.*)/i, async (context) => {
    if (context.args) {
        await context.send(`Hello, ${context.args[1]}!`);
    }
});
```

In this example, the bot listens for messages that start with "hello" followed by any text. When such a message is received, the bot extracts the text after "hello" and sends a personalized greeting.

### Using a `String` matcher

If you want your bot to respond to a specific word or phrase, you can use a string trigger.

```ts
bot.hears("start", async (context) => {
    await context.send("Welcome! Type 'help' to see available commands.");
});
```

In this case, the bot listens for the exact word "start" and replies with a welcome message.

### Using a `Function` matcher

For more advanced scenarios, you can use a function to define the trigger. This function checks the message context and decides whether to trigger the response.

```ts
bot.hears(
    (context) => context.user.role === "admin",
    async (context) => {
        await context.send("Hello, Admin! How can I assist you?");
    }
);
```

Here, the bot checks if the user is an admin. If so, it sends a special message for admins.

---

---
url: 'https://gramio.dev/extend/middleware.md'
---

# Middleware & Context

Every Telegram update that arrives at your bot is just **data flowing through a pipeline**. GramIO gives you a type-safe, chainable API to shape that pipeline exactly how you need — layer by layer, with TypeScript tracking everything along the way.

::: tip Quick orientation
If you're looking for the low-level engine that powers all this, see [@gramio/composer](./composer.md).
This page focuses on the patterns you'll actually use when building bots.
:::

## The Mental Model

Think of your bot as an assembly line. An update enters from the left, passes through each station, and exits (or gets stopped) on the right:

```
Update → [logger] → [fetchUser] → [guard: isAdmin?] → [handler] → Response
                                         ↓ false
                                      (stopped)
```

Each "station" is a middleware. They run **in registration order**. The key insight: **every method returns the updated bot**, so you always chain.

## Walk Through It Interactively

Toggle `user.isAdmin` to see how a guard changes what reaches the handler:

Watch how `ctx` grows as each `derive()` fires, and how the guard completely blocks the handler when the condition isn't met.

## Always Chain

GramIO's type system is built on method chaining. Each method records what it added to `ctx` and returns the updated type. If you break the chain, TypeScript loses that information:

```ts twoslash
import { Bot } from "gramio";
// ---cut---
// ✅ Correct — types flow through the chain
const bot = new Bot(process.env.BOT_TOKEN as string)
    .derive(() => ({ db: { getUser: (id: number) => ({ name: "Alice" }) } }))
    .command("start", (ctx) => {
        ctx.db.getUser(1); // ✅ fully typed
    });
```

```ts twoslash
import { Bot } from "gramio";
// ---cut---
// ❌ Breaking the chain loses types
const bot = new Bot(process.env.BOT_TOKEN as string);
bot.derive(() => ({ db: { getUser: (id: number) => ({ name: "Alice" }) } }));
bot.command("start", (ctx) => {
    // @ts-expect-error — ctx.db doesn't exist! The derive was registered on a
    // different (discarded) type than the one .command() sees.
    ctx.db;
});
```

Always build your bot as one chained expression, or save the intermediate result and continue from it:

```ts twoslash
import { Bot } from "gramio";
// ---cut---
const withDb = new Bot(process.env.BOT_TOKEN as string)
    .derive(() => ({ db: { getUser: (id: number) => ({ name: "Alice" }) } }));

// Continue chaining from the result — types are preserved
withDb.command("start", (ctx) => {
    ctx.db.getUser(1); // ✅
});
```

## Enriching Context: derive()

`derive()` runs a function **per update** and merges the returned object into `ctx`. Everything registered after it sees the new properties — fully typed.

```ts twoslash
import { Bot } from "gramio";
// ---cut---
const bot = new Bot(process.env.BOT_TOKEN as string)
    .derive(async () => {
        // In real code: const user = await db.getUser(ctx.from!.id)
        const user = { id: 42, name: "Alice", isAdmin: false };
        return { user };
    })
    .command("start", async (ctx) => {
        ctx.user.name; // ✅ string — TypeScript knows!
        //   ^?
        await ctx.send(`Hello, ${ctx.user.name}!`);
    });
```

### Scoped derive()

Run a derive only for specific update types to keep context lean:

```ts twoslash
import { Bot } from "gramio";
// ---cut---
const bot = new Bot(process.env.BOT_TOKEN as string)
    // Only runs when the update is a message
    .derive("message", (ctx) => ({
        wordCount: (ctx.text ?? "").split(" ").length,
    }))
    .on("message", (ctx) => {
        ctx.wordCount; // ✅ available here
        //  ^?
    });
```

Use `.is()` for type narrowing in a global handler:

```ts
const bot = new Bot(process.env.BOT_TOKEN as string)
    .derive("message", () => ({ isMessage: true as const }))
    .use((ctx) => {
        if (ctx.is("message")) {
            ctx.isMessage; // ✅ narrowed
        }
    });
```

## Static Values: decorate()

When you have values that don't change per request — a database connection, a config object, a service client — use `decorate()`. The object is assigned **once** at startup, not re-created on every update:

```ts twoslash
import { Bot } from "gramio";
// ---cut---
const db = { getUser: (id: number) => Promise.resolve({ name: "Alice" }) };
const config = { maxRetries: 3, environment: "production" as const };

const bot = new Bot(process.env.BOT_TOKEN as string)
    .decorate({ db, config })
    .command("start", async (ctx) => {
        const user = await ctx.db.getUser(ctx.from!.id);
        //                  ^?
        ctx.send(`Hello! (env: ${ctx.config.environment})`);
    });
```

| | `derive()` | `decorate()` |
|---|---|---|
| Runs | Per update | Once at startup |
| Use for | Fetched/computed values | DB connections, clients, config |
| Overhead | Function call per update | Zero — same reference every time |

## Routing: on()

`.on()` registers a handler for a specific update type. The chain **continues** regardless of whether the type matched — it's not a stopper, it's a type-specific handler:

```ts
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string)
    // Only runs for text messages
    .on("message", (ctx) => ctx.send("Got a message!"))
    // Only runs for inline button presses
    .on("callback_query", (ctx) => ctx.answerCallbackQuery("Clicked!"));
    // Both are registered — each only fires for its own update type
```

## Build-Time Conditionals: when()

::: info Composer-level API
`when()` is available on `Composer` from `gramio`. Create your pipeline as a `Composer`, then pass it to `bot.extend()`.
:::

Register middleware conditionally at **startup** (not per-request) using `when()`. The middleware is either registered or not — there's no runtime overhead:

```ts
import { Bot } from "gramio";
import { Composer } from "gramio";

const pipeline = new Composer()
    .when(
        process.env.NODE_ENV !== "production",
        (c) => c.use(async (ctx, next) => {
            const start = Date.now();
            await next();
            console.log(`[${ctx.updateType}] ${Date.now() - start}ms`);
        })
    )
    .derive(() => ({ timestamp: Date.now() }));

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(pipeline)
    .command("start", (ctx) => ctx.send("Hello!"));
```

Properties added inside a `when()` block are typed as **`Partial`** (optional) — TypeScript correctly reflects that the middleware might not be registered.

## Composing & Reusing Middleware

The real power comes when you extract common middleware into a **`Composer`** and reuse it across your bot:

```ts
import { Bot } from "gramio";
import { Composer } from "gramio";

// ── shared middleware ─────────────────────────────────────────────────
const db = {
    getUser: (id: number) =>
        Promise.resolve({ id, name: "Alice", premium: true }),
};

const userMiddleware = new Composer()
    .derive(async () => ({
        // In real code: user: await db.getUser(ctx.from!.id)
        user: await db.getUser(0),
    }));

// ── bot ───────────────────────────────────────────────────────────────
const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(userMiddleware)       // user is now available everywhere below
    .command("start", (ctx) => {
        ctx.user.name;            // ✅ typed — came from userMiddleware.derive()
        ctx.send(`Hello, ${ctx.user.name}!`);
    })
    .command("profile", (ctx) => {
        ctx.send(`Premium: ${ctx.user.premium}`);
    });
```

`Composer` from `gramio` is the building block for reusable middleware. Think of it as a named, extractable pipeline segment.

### Middleware order matters

Middleware runs in **registration order**. A `Composer` injects its middleware at the point where you call `.extend()`:

```ts
import { Bot } from "gramio";
import { Composer } from "gramio";

const logger = new Composer().use(async (ctx, next) => {
    console.log("before:", ctx.updateType);
    await next();
    console.log("after");
});

const bot = new Bot(process.env.BOT_TOKEN as string)
    .use(async (_, next) => { console.log("1"); await next() })  // 1st
    .extend(logger)                                               // 2nd (logger's middleware)
    .use(async (_, next) => { console.log("3"); await next() })  // 3rd
    .command("start", () => console.log("4"));                   // 4th
```

## Using Context Types in Handler Functions

Handlers defined inline always have correct types inferred. But when you extract a handler to a separate function, you need to annotate the parameter. Build the composer first and derive its type:

```ts
import { Bot } from "gramio";
import { Composer } from "gramio";

const userMiddleware = new Composer().derive(() => ({
    user: { name: "Alice", premium: true as boolean },
}));

// Derive the context type from the composer
type WithUser = typeof userMiddleware extends Composer<infer C, any> ? C : never;

// Use it in a standalone handler function
async function greetHandler(ctx: WithUser) {
    await ctx.send(`Hello, ${ctx.user.name}!`);
}

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(userMiddleware)
    .command("greet", greetHandler);
```

::: tip Prefer inline handlers for small functions
For simple handlers, keeping them inline in the chain is the most ergonomic — types are inferred automatically. Extract to standalone functions when the logic is complex enough to deserve its own test or file.
:::

## Practical Patterns

### Reusable user middleware

```ts
import { Bot } from "gramio";
import { Composer } from "gramio";

const db = {
    getUser: (id: number) =>
        Promise.resolve({ id, name: "Alice", role: "admin" as "admin" | "user" }),
};

// Fetch user — reusable on any event type
const withUser = new Composer()
    .derive(async (ctx) => ({
        db,
        user: await db.getUser(ctx.from?.id ?? 0),
    }));

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(withUser)
    .command("profile", (ctx) => ctx.send(`Hello, ${ctx.user.name}!`))
    .command("role",    (ctx) => ctx.send(`Role: ${ctx.user.role}`));
```

### Splitting into files

```ts
// middleware/user.ts
import { Composer } from "gramio";
export const withUser = new Composer()
    .derive(async (ctx) => ({ user: await db.getUser(ctx.from?.id ?? 0) }));

// bot.ts
import { withUser } from "./middleware/user";
const bot = new Bot(TOKEN)
    .extend(withUser)
    .command("start", (ctx) => { /* ctx.user available */ });
```

### Feature flag middleware

```ts
import { Bot } from "gramio";
import { Composer } from "gramio";

const FEATURES = {
    betaAnalytics: process.env.FEATURE_ANALYTICS === "true",
    debugMode:     process.env.NODE_ENV !== "production",
};

// Build the conditional pipeline with Composer
const featurePipeline = new Composer()
    .when(FEATURES.debugMode, (c) => c.use(async (ctx, next) => {
        const start = Date.now();
        await next();
        console.log(`[${ctx.updateType}] ${Date.now() - start}ms`);
    }));

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(featurePipeline)
    .command("start", (ctx) => ctx.send("Hello!"));
```

## Production Architecture

As your bot grows beyond a single file, layering **named** Composers lets each module declare its own dependencies and stay self-contained — while GramIO's deduplication ensures shared middleware runs exactly once per update.

```
bot
  .extend(withUser)    ← scoped: derive writes ctx.user to the real ctx
  .extend(adminRouter) ← withUser inside → dedup: skipped
  .extend(chatRouter)  ← withUser/withChat inside → dedup: skipped

  adminRouter: .extend(withUser) + .guard + commands   (types only)
  chatRouter:  .extend(withUser) + .extend(withChat) + handlers
```

### 1. Shared base: `withUser`

Name your shared Composer and mark it `.as("scoped")`. Both matter:

```ts
// middleware/user.ts
import { Composer } from "gramio";

export const db = {
    getUser: (id: number) =>
        Promise.resolve({ id, name: "Alice", role: "admin" as "admin" | "user" }),
    getChat: (id: number) =>
        Promise.resolve({ id, title: "My Chat", language: "en" }),
};

export const withUser = new Composer({ name: "withUser" })
    .decorate({ db })
    .derive(async (ctx) => ({
        user: await db.getUser(ctx.from?.id ?? 0),
    }))
    .as("scoped");
```

**`{ name: "withUser" }`** — GramIO tracks extended names in a `Set`. When `bot.extend(adminRouter)` runs and `adminRouter` already extended `withUser`, the key `"withUser:null"` is transferred to `bot`'s extended set. Any later `bot.extend(withUser)` (or from another router) becomes a no-op. Dedup is transitive.

**`.as("scoped")`** — by default `extend()` wraps the extended composer's middleware in an isolation group via `Object.create(ctx)`. Derives run, but their results stay inside the group and don't propagate back to the parent `ctx`. `.as("scoped")` opts out of this: the middleware is added as a plain function on the parent `ctx`, so `ctx.user` is written to the real `ctx` and readable everywhere through JavaScript's prototype chain.

### 2. Admin router

```ts
// routers/admin.ts
import { Composer } from "gramio";
import { withUser } from "../middleware/user";

export const adminRouter = new Composer({ name: "adminRouter" })
    .extend(withUser)                              // types ✅  ctx.db ✅
    .guard((ctx) => ctx.user.role === "admin")     // non-admins stopped here
    .command("ban", (ctx) =>
        ctx.send(`Banned! (by ${ctx.user.name})`))
    .command("stats", async (ctx) => {
        const target = await ctx.db.getUser(42);
        ctx.send(`Stats for: ${target.name}`);
    })
    .command("kick", (ctx) => ctx.send("Kicked!"));
```

TypeScript infers `ctx.user` and `ctx.db` because `adminRouter` extends `withUser`. At runtime — when `bot` extends `withUser` first — dedup skips `withUser` inside `adminRouter`. The derive never runs twice.

### 3. Chat router

```ts
// routers/chat.ts
import { Composer } from "gramio";
import { db, withUser } from "../middleware/user";

const withChat = new Composer({ name: "withChat" })
    .derive("message", async (ctx) => ({
        chatRecord: await db.getChat(ctx.chat.id),
    }))
    .as("scoped");

export const chatRouter = new Composer({ name: "chatRouter" })
    .extend(withUser)   // types ✅  ctx.db ✅
    .extend(withChat)   // ctx.chatRecord ✅  (Partial outside message handlers)
    .on("message", (ctx) => {
        ctx.send(`${ctx.user.name} in ${ctx.chatRecord.title}`);
    })
    .command("topic", (ctx) =>
        ctx.send(`Language: ${ctx.chatRecord?.language ?? "unknown"}`))
    .command("rules", (ctx) =>
        ctx.send(`Chat: ${ctx.chatRecord?.title ?? "unknown"}`));
```

Note: `ctx.chat` (no suffix) is GramIO's built-in Telegram event property — `chatRecord` avoids the name collision.

### 4. Assembling in `bot.ts`

```ts
// bot.ts
import { Bot } from "gramio";
import { withUser }    from "./middleware/user";
import { adminRouter } from "./routers/admin";
import { chatRouter }  from "./routers/chat";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(withUser)    // ← FIRST: scoped derive writes ctx.user to the real ctx
    .extend(adminRouter) // dedup: withUser inside adminRouter → skipped
    .extend(chatRouter)  // dedup: withUser + withChat inside chatRouter → skipped
    .command("start", (ctx) => ctx.send("Hello!"))
    .start();
```

`withUser` must come **before** the routers. After this, `ctx.user` sits on the real `ctx` — every isolation group created by subsequent `extend()` calls reads it transparently through the prototype chain.

### The dedup gotcha

::: warning Dedup ≠ shared data
Naming a Composer enables deduplication at **registration time**. But if you only extend `withUser` inside sub-composers (not at the top level), dedup removes it from the second router — yet the first router's isolation group still owns the result:

```
isolated_adminRouter: [decorate, derive, adminHandlers] ← ctx.user written here
isolated_chatRouter:  [chatHandlers]                    ← ctx.user NOT visible ❌
```

TypeScript types are correct; runtime behavior is not. This is the only place in GramIO where the two diverge.

**Fix**: extend `withUser` with `.as("scoped")` at the top level **before** the routers, as shown in `bot.ts` above.
:::

### When it doesn't matter

If your routers are **mutually exclusive** — each update is handled by exactly one of them — you'll never hit this. The admin guard stops non-admins; the chat router only handles events that weren't matched earlier. Each update flows through exactly one isolation group, so the gotcha never triggers.

It only bites when two routers both call `next()` for the same update, which is rare in practice.

### What each layer sees

| Layer | `ctx.user` | `ctx.db` | `ctx.chatRecord` | Guard |
|-------|-----------|---------|-----------------|-------|
| `bot` (top-level) | ✅ | ✅ | — | — |
| `adminRouter` | ✅ | ✅ | — | user.role === "admin" |
| `chatRouter` (message) | ✅ | ✅ | ✅ | — |
| `chatRouter` (other) | ✅ | ✅ | Partial | — |

One DB query per update, `ctx.user` available everywhere.

::: tip `guard()` lives on Composer
`guard()` is available on `Composer` from `gramio`, not on `Bot` directly. That's why `adminRouter` is a `Composer` — it gets the full composition API — and is then passed to `bot.extend()`.
:::

## Summary

| Method | When to use |
|--------|-------------|
| `use(fn)` | Raw middleware — needs `next()` call, wraps the whole chain |
| `derive(fn)` | Add computed values to `ctx` per update |
| `derive(type, fn)` | Same, but only for specific update types |
| `decorate(obj)` | Add static values (DB clients, config) once at startup |
| `on(type, fn)` | Handle specific update types (chain always continues) |
| `when(cond, fn)` | Build-time conditional registration (Composer-level) |
| `extend(composer)` | Merge a `Composer` into the pipeline at this position |

For the underlying engine (including `guard()`, `branch()`, `inspect()`, `trace()`), see [@gramio/composer](./composer.md).

---

---
url: 'https://gramio.dev/guides/migration-from-grammy.md'
---

# Migrating from grammY

This guide is for developers with a bot written in [grammY](https://grammy.dev/) who want to switch to GramIO. Both are TypeScript-first, middleware-based frameworks — the mental model is very similar, but the APIs differ in important ways.

***

## Why migrate?

| | grammY | GramIO |
|---|---|---|
| TypeScript context extension | Manual flavor interfaces + generic `Bot<Ctx>` | `.derive()` / `.extend()` — types flow automatically |
| Plugin typing | `SessionFlavor<T>`, `ConversationFlavor`, etc. | `.extend(plugin())` — no flavor types needed |
| Formatting | HTML / MarkdownV2 strings or `fmt` helper | Tagged template literals → `MessageEntity` |
| Conversations / multi-step flows | `@grammyjs/conversations` — async generator style | `@gramio/scenes` — step-based, typed state |
| Built-in test utilities | ❌ | ✅ `@gramio/test` |
| Full Telegram API reference | ❌ | ✅ `/telegram/` |
| Scaffolding CLI | ❌ | ✅ `npm create gramio` |
| Filters syntax | `bot.on(":text")`, `bot.on(["msg:text", ...])` | Plain event names + `.filter()` / `.derive()` |
| `ctx.reply()` | Sends a reply to the incoming message | `ctx.send()` — same behavior, different name |

***

## Installation

::: pm-add gramio
:::

::: pm-remove grammy
:::

***

## Bot initialization

Both frameworks use `new Bot(token)` and `bot.start()` — initialization is nearly identical.

::: code-group

```ts [grammY]
import { Bot } from "grammy";

const bot = new Bot(process.env.BOT_TOKEN!);

bot.start();
```

```ts [GramIO]
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string);

bot.start();
```

:::

The import source changes from `"grammy"` to `"gramio"` — everything else stays the same.

***

## Handlers

::: code-group

```ts [grammY]
// Command
bot.command("start", (ctx) => ctx.reply("Hello!"));

// Any message
bot.on("message", (ctx) => ctx.reply("Got it!"));

// Text filter (grammY shorthand syntax)
bot.on("message:text", (ctx) => ctx.reply(ctx.message.text));

// Hears
bot.hears(/hello/i, (ctx) => ctx.reply("Hey!"));

// Callback query
bot.callbackQuery("yes", async (ctx) => {
    await ctx.answerCallbackQuery();
    await ctx.reply("You said yes!");
});
```

```ts [GramIO]
// Command
bot.command("start", (ctx) => ctx.send("Hello!"));

// Any message
bot.on("message", (ctx) => ctx.send("Got it!"));

// Text available as ctx.text on message context
bot.on("message", (ctx) => ctx.send(ctx.text ?? ""));

// Hears
bot.hears(/hello/i, (ctx) => ctx.send("Hey!"));

// Callback query
bot.callbackQuery("yes", (ctx) => {
    ctx.answer(); // auto-acknowledges
    ctx.send("You said yes!");
});
```

:::

**Key changes:**

* `ctx.reply()` → `ctx.send()`
* `bot.on("message:text")` grammY filter → plain `bot.on("message")` with `ctx.text`
* `ctx.answerCallbackQuery()` → `ctx.answer()`

***

## Context properties

::: code-group

```ts [grammY]
ctx.message          // Message | undefined
ctx.message?.text    // string | undefined
ctx.from             // User | undefined
ctx.chat             // Chat | undefined
ctx.update           // raw Update object
ctx.callbackQuery    // CallbackQuery | undefined
```

```ts [GramIO]
ctx.message          // TelegramMessage | undefined
ctx.text             // string | undefined  (shorthand on message ctx)
ctx.from             // TelegramUser | undefined
ctx.chat             // TelegramChat | undefined
// callback_query is a top-level property on callbackQuery events
```

:::

***

## Sending messages

::: code-group

```ts [grammY]
await ctx.reply("Hello!");
await ctx.reply("<b>Hello!</b>", { parse_mode: "HTML" });
await ctx.replyWithPhoto("file_id");
await ctx.api.sendMessage(chatId, "Hello from outside!");
```

```ts [GramIO]
await ctx.send("Hello!");

import { format, bold } from "gramio";
await ctx.send(format`${bold`Hello!`}`); // no parse_mode needed

await ctx.sendPhoto("file_id");
await bot.api.sendMessage({ chat_id: chatId, text: "Hello from outside!" });
```

:::

**Key changes:**

* `ctx.reply()` → `ctx.send()`
* `ctx.replyWithPhoto()` → `ctx.sendPhoto()`
* `ctx.api.method(positional, args)` → `bot.api.method({ named_params })`
* No `parse_mode` — use `format` tagged template literals

***

## Direct API calls

::: code-group

```ts [grammY]
// Positional arguments
await ctx.api.sendMessage(chatId, "Hello!");
await ctx.api.sendPhoto(chatId, "file_id");
await ctx.api.banChatMember(chatId, userId);

// Outside a handler
await bot.api.sendMessage(chatId, "Hello!");
```

```ts [GramIO]
// Named arguments
await ctx.api.sendMessage({ chat_id: chatId, text: "Hello!" });
await ctx.api.sendPhoto({ chat_id: chatId, photo: "file_id" });
await ctx.api.banChatMember({ chat_id: chatId, user_id: userId });

// Outside a handler
await bot.api.sendMessage({ chat_id: chatId, text: "Hello!" });
```

:::

**Key change:** grammY uses positional arguments, GramIO uses named params matching the official Telegram Bot API docs.

***

## Keyboards

Both frameworks share similar keyboard class names, but the import source changes.

::: code-group

```ts [grammY]
import { InlineKeyboard, Keyboard } from "grammy";

// Inline keyboard
ctx.reply("Choose:", {
    reply_markup: new InlineKeyboard()
        .text("Yes ✅", "yes")
        .text("No ❌", "no")
        .row()
        .url("GitHub", "https://github.com/gramiojs/gramio"),
});

// Reply keyboard
ctx.reply("Choose:", {
    reply_markup: new Keyboard()
        .text("Option A")
        .text("Option B")
        .resized(),
});

// Remove keyboard
ctx.reply("Removed.", { reply_markup: { remove_keyboard: true } });
```

```ts [GramIO]
import { InlineKeyboard, Keyboard, RemoveKeyboard } from "gramio";

// Inline keyboard
ctx.send("Choose:", {
    reply_markup: new InlineKeyboard()
        .text("Yes ✅", "yes")
        .text("No ❌", "no")
        .row()
        .url("GitHub", "https://github.com/gramiojs/gramio"),
});

// Reply keyboard
ctx.send("Choose:", {
    reply_markup: new Keyboard()
        .text("Option A")
        .text("Option B")
        .resized(),
});

// Remove keyboard
ctx.send("Removed.", { reply_markup: new RemoveKeyboard() });
```

:::

**Key changes:**

* Import from `"gramio"` instead of `"grammy"`
* `ctx.reply()` → `ctx.send()`
* `{ remove_keyboard: true }` → `new RemoveKeyboard()`

***

## Type-safe callback data

::: code-group

```ts [grammY]
// Building
ctx.reply("Choose:", {
    reply_markup: new InlineKeyboard()
        .text("Item 1", "action:1")
        .text("Item 2", "action:2"),
});

// Handling
bot.callbackQuery(/action:(\d+)/, async (ctx) => {
    const id = parseInt(ctx.match[1]);
    await ctx.reply(`You picked: ${id}`);
    await ctx.answerCallbackQuery();
});
```

```ts [GramIO]
import { CallbackData, InlineKeyboard } from "gramio";

const actionData = new CallbackData("action").number("id");

// Building
ctx.send("Choose:", {
    reply_markup: new InlineKeyboard()
        .text("Item 1", actionData.pack({ id: 1 }))
        .text("Item 2", actionData.pack({ id: 2 })),
});

// Handling
bot.callbackQuery(actionData, (ctx) => {
    ctx.send(`You picked: ${ctx.queryData.id}`);
    //                                  ^? number
});
```

:::

***

## Formatting

::: code-group

```ts [grammY]
await ctx.reply(
    "<b>Hello!</b> Visit <a href='https://gramio.dev'>GramIO</a>.",
    { parse_mode: "HTML" }
);
```

```ts [GramIO]
import { format, bold, link } from "gramio";

await ctx.send(
    format`${bold`Hello!`} Visit ${link("GramIO", "https://gramio.dev")}.`
);
```

:::

***

## TypeScript / Adding custom context

grammY requires declaring "flavor" interfaces and passing them as generics. GramIO's `.derive()` and `.extend()` infer everything automatically.

::: code-group

```ts [grammY]
import { Bot, Context, SessionFlavor, session } from "grammy";

// 1. Declare flavor types
interface SessionData { count: number }
type MyContext = Context & SessionFlavor<SessionData>;

// 2. Pass the generic to every construct
const bot = new Bot<MyContext>(token);

// 3. Register middleware with the generic
bot.use(session<MyContext, SessionData>({
    initial: () => ({ count: 0 }),
}));

// 4. Custom properties need manual flavor augmentation
interface CustomFlavor { isAdmin: boolean }
type FullContext = Context & SessionFlavor<SessionData> & CustomFlavor;
```

```ts [GramIO]
import { Bot } from "gramio";
import { session } from "@gramio/session";

// No generics or flavor types — just compose and types flow
const bot = new Bot(token)
    .extend(session({ initial: () => ({ count: 0 }) }))
    .derive((ctx) => ({
        isAdmin: ctx.from?.id === ADMIN_ID,
    }));

bot.on("message", (ctx) => {
    ctx.isAdmin;    // ✅ boolean — inferred
    ctx.session;    // ✅ { count: number } — inferred
});
```

:::

***

## Session

::: code-group

```ts [grammY]
import { Bot, Context, SessionFlavor, session } from "grammy";

interface SessionData { count: number }
type MyContext = Context & SessionFlavor<SessionData>;

const bot = new Bot<MyContext>(token);
bot.use(session({ initial: (): SessionData => ({ count: 0 }) }));

bot.command("count", async (ctx) => {
    ctx.session.count++;
    await ctx.reply(`Count: ${ctx.session.count}`);
});
```

```ts [GramIO]
import { Bot } from "gramio";
import { session } from "@gramio/session";

const bot = new Bot(token).extend(
    session({ initial: () => ({ count: 0 }) })
);

bot.command("count", (ctx) => {
    ctx.session.count++;
    //    ^? { count: number }
    ctx.send(`Count: ${ctx.session.count}`);
});
```

:::

***

## Conversations / Scenes

grammY's `@grammyjs/conversations` uses an async-generator/`conversation.wait()` pattern. GramIO's `@gramio/scenes` uses a step-based approach.

::: code-group

```ts [grammY — @grammyjs/conversations]
import { conversations, createConversation } from "@grammyjs/conversations";
import { session } from "grammy";

async function register(conversation, ctx) {
    await ctx.reply("What's your name?");
    const { message } = await conversation.wait();
    await ctx.reply(`Hello, ${message.text}!`);
}

bot.use(session({ initial: () => ({}) }));
bot.use(conversations());
bot.use(createConversation(register));

bot.command("register", (ctx) => ctx.conversation.enter("register"));
```

```ts [GramIO — @gramio/scenes]
import { Scene, scenes } from "@gramio/scenes";
import { session } from "@gramio/session";

const registerScene = new Scene("register")
    .step("message", (ctx) => {
        if (ctx.scene.step.firstTime) return ctx.send("What's your name?");
        return ctx.scene.update({ name: ctx.text });
    })
    .step("message", (ctx) =>
        ctx.send(`Hello, ${ctx.scene.state.name}!`)
    );

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(session())
    .extend(scenes([registerScene]));

bot.command("register", (ctx) => ctx.scene.enter(registerScene));
```

:::

**Key changes:**

* No `conversation.wait()` — steps advance automatically when matching updates arrive
* State is typed: `ctx.scene.state` carries what you passed to `ctx.scene.update()`
* No `ConversationFlavor` type — GramIO infers everything from the scene definition

***

## Error handling

::: code-group

```ts [grammY]
// Global error handler
bot.catch((err) => {
    const ctx = err.ctx;
    console.error(`Error while handling update ${ctx.update.update_id}:`);
    console.error(err.error);
});
```

```ts [GramIO]
// Centralized error handler
bot.onError(({ context, kind, error }) => {
    console.error(kind, error.message);
    if (context.is("message")) context.send("Something went wrong.");
});

// Custom typed errors
class NoRights extends Error {
    constructor(public role: "admin" | "moderator") { super(); }
}

const bot = new Bot(process.env.BOT_TOKEN as string)
    .error("NO_RIGHTS", NoRights)
    .onError(({ kind, error, context }) => {
        if (kind === "NO_RIGHTS" && context.is("message"))
            context.send(`You need the «${error.role}» role.`);
    });
```

:::

**Key changes:**

* `bot.catch((err) => ...)` → `bot.onError(({ context, kind, error }) => ...)`
* Errors can be given typed names with `.error("KIND", ErrorClass)`

***

## Graceful shutdown

::: code-group

```ts [grammY]
// grammY handles SIGINT/SIGTERM automatically when using bot.start()
bot.start({
    onStop: () => console.log("Shutting down"),
});
```

```ts [GramIO]
bot.onStop(() => console.log("Shutting down"));

process.on("SIGINT", () => bot.stop());
process.on("SIGTERM", () => bot.stop());

bot.start();
```

:::

***

## Webhook

::: code-group

```ts [grammY]
import { Bot, webhookCallback } from "grammy";
import express from "express";

const bot = new Bot(process.env.BOT_TOKEN!);
const app = express();

app.use(express.json());
app.use("/webhook", webhookCallback(bot, "express"));
app.listen(3000);
```

```ts [GramIO]
import { Bot, webhookHandler } from "gramio";
import Fastify from "fastify";

const bot = new Bot(process.env.BOT_TOKEN as string);
const fastify = Fastify();

fastify.post("/webhook", webhookHandler(bot, "fastify"));
fastify.listen({ port: 3000, host: "::" });

// Calls setWebhook on Telegram — does NOT start an HTTP server
bot.start({
    webhook: { url: "https://example.com/webhook" },
});
```

:::

See [all supported frameworks →](/updates/webhook) (Hono, Express, Elysia, Koa, Bun.serve, Deno.serve, node:http)

***

## Middleware

Both frameworks use identical `(ctx, next) => ...` middleware chains.

::: code-group

```ts [grammY]
bot.use(async (ctx, next) => {
    console.log("Before:", ctx.update.update_id);
    await next();
    console.log("After");
});
```

```ts [GramIO]
bot.use(async (ctx, next) => {
    console.log("Before:", ctx.update);
    await next();
    console.log("After");
});
```

:::

The shape is identical — `bot.use()` works the same way.

***

## Files

::: code-group

```ts [grammY]
import { InputFile } from "grammy";

await ctx.replyWithPhoto(new InputFile("./photo.jpg"));
await ctx.replyWithPhoto(new InputFile(new URL("https://example.com/photo.jpg")));
await ctx.replyWithPhoto(new InputFile(buffer, "photo.jpg"));
```

```ts [GramIO]
import { MediaUpload } from "@gramio/files";

await ctx.sendPhoto(await MediaUpload.path("./photo.jpg"));
await ctx.sendPhoto(await MediaUpload.url("https://example.com/photo.jpg"));
await ctx.sendPhoto(await MediaUpload.buffer(buffer, "photo.jpg"));

// Already-uploaded file_id — pass directly
await ctx.sendPhoto("AgACAgIAAxk...");
```

:::

***

## Quick reference

| grammY | GramIO |
|---|---|
| `import { Bot } from "grammy"` | `import { Bot } from "gramio"` |
| `bot.start()` | `bot.start()` |
| `ctx.reply(text)` | `ctx.send(text)` |
| `ctx.replyWithPhoto(file_id)` | `ctx.sendPhoto(file_id)` |
| `ctx.api.sendMessage(id, text)` | `ctx.api.sendMessage({ chat_id: id, text })` |
| `bot.api.sendMessage(id, text)` | `bot.api.sendMessage({ chat_id: id, text })` |
| `ctx.answerCallbackQuery()` | `ctx.answer()` |
| `bot.on("message:text")` | `bot.on("message")` + `ctx.text` |
| `type Ctx = Context & SessionFlavor<T>` | `.extend(session({...}))` |
| `new Bot<MyContext>(token)` | `new Bot(token)` (no generic needed) |
| `bot.use(session({...}))` | `.extend(session({...}))` |
| `@grammyjs/conversations` | `@gramio/scenes` |
| `conversation.wait()` | step advances automatically |
| `bot.catch((err) => ...)` | `bot.onError(({ error, context }) => ...)` |
| `new InputFile("path")` | `await MediaUpload.path("path")` |
| HTML / MarkdownV2 strings | `format\`${bold\`text\`}\``|
|`import { InlineKeyboard } from "grammy"`|`import { InlineKeyboard } from "gramio"`|
|`{ remove\_keyboard: true }`|`new RemoveKeyboard()\` |

***

## Next steps

* [Get started →](/get-started) — Scaffold a new GramIO project
* [Plugins overview →](/plugins/overview) — Sessions, scenes, i18n and more
* [Cheat Sheet →](/cheat-sheet) — Common patterns at a glance
* [Introduction →](/introduction) — Why GramIO, at a glance

---

---
url: 'https://gramio.dev/guides/migration-from-ntba.md'
---

# Migrating from node-telegram-bot-api

This guide is for developers who have a bot written with [node-telegram-bot-api](https://github.com/yagop/node-telegram-bot-api) (NTBA) and want to switch to GramIO. NTBA is a minimal, callback-based library — GramIO gives you a full framework with middleware, typed context, keyboards builder, sessions, and first-class TypeScript.

***

## Why migrate?

| | node-telegram-bot-api | GramIO |
|---|---|---|
| TypeScript | External `@types/` package, limited | First-class, fully inferred |
| Middleware | ❌ | ✅ composable `.use()` / `.derive()` |
| Context object | ❌ (raw `msg` object) | ✅ rich `ctx` with helper methods |
| Keyboard builders | ❌ (raw JSON) | ✅ `InlineKeyboard`, `Keyboard` |
| Sessions | ❌ (manual state) | ✅ `@gramio/session` |
| Conversations / flows | ❌ | ✅ `@gramio/scenes` + `@gramio/prompt` |
| Formatting | Manual HTML strings | Tagged template literals → entities |
| Built-in test utilities | ❌ | ✅ `@gramio/test` |
| Plugin system | ❌ | ✅ `.extend()` with type propagation |
| Full Telegram API reference | ❌ | ✅ `/telegram/` |
| Scaffolding CLI | ❌ | ✅ `npm create gramio` |

***

## Installation

::: pm-add gramio
:::

::: pm-remove node-telegram-bot-api @types/node-telegram-bot-api
:::

***

## Bot initialization

::: code-group

```ts [NTBA]
import TelegramBot from "node-telegram-bot-api";

const bot = new TelegramBot(process.env.BOT_TOKEN!, { polling: true });
```

```ts [GramIO]
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string);

bot.start();
```

:::

**Key changes:**

* Import is a named `Bot` class, not a default export
* Pass options to `bot.start()` instead of the constructor
* Long polling is the default — no extra config needed

***

## Handlers

::: code-group

```ts [NTBA]
// Any message
bot.on("message", (msg) => {
    bot.sendMessage(msg.chat.id, "Got it!");
});

// Regex match
bot.onText(/\/start/, (msg) => {
    bot.sendMessage(msg.chat.id, "Hello!");
});

// Regex with capture group
bot.onText(/\/say (.+)/, (msg, match) => {
    const text = match?.[1] ?? "nothing";
    bot.sendMessage(msg.chat.id, text);
});

// Callback query (button press)
bot.on("callback_query", (query) => {
    bot.answerCallbackQuery(query.id);
    if (query.data === "yes") {
        bot.sendMessage(query.message!.chat.id, "You said yes!");
    }
});
```

```ts [GramIO]
// Any message
bot.on("message", (ctx) => ctx.send("Got it!"));

// Command
bot.command("start", (ctx) => ctx.send("Hello!"));

// Hears (regex)
bot.hears(/\/say (.+)/, (ctx) => ctx.send(ctx.args?.[1] ?? "nothing"));

// Callback query (button press)
bot.callbackQuery("yes", (ctx) => {
    ctx.answer(); // auto-acknowledges the query
    ctx.send("You said yes!");
});
```

:::

**Key changes:**

* `bot.on("message", (msg) => ...)` → `bot.on("message", (ctx) => ...)`
* No more `msg.chat.id` — just `ctx.send()` replies in context
* `bot.onText(/regex/)` → `bot.hears(/regex/)`, with `ctx.args` for capture groups
* `bot.command("start")` for `/start` commands (cleaner than `bot.onText(/\/start/)`)
* `bot.callbackQuery("data")` instead of filtering inside `bot.on("callback_query")`
* `ctx.answer()` instead of `bot.answerCallbackQuery(query.id)`

***

## Sending messages

::: code-group

```ts [NTBA]
// Plain text
await bot.sendMessage(msg.chat.id, "Hello!");

// HTML
await bot.sendMessage(msg.chat.id, "<b>Bold</b>", { parse_mode: "HTML" });

// Photo
await bot.sendPhoto(msg.chat.id, "file_id");

// Document
await bot.sendDocument(msg.chat.id, "file_id");

// Edit a message
await bot.editMessageText("New text", {
    chat_id: msg.chat.id,
    message_id: msg.message_id,
});
```

```ts [GramIO]
// Plain text
await ctx.send("Hello!");

// Formatted (no parse_mode needed)
import { format, bold } from "gramio";
await ctx.send(format`${bold`Bold`}`);

// Photo
await ctx.sendPhoto("file_id");

// Document
await ctx.sendDocument("file_id");

// Edit a message (inside a handler)
await ctx.editText("New text");
```

:::

**Key changes:**

* Every `bot.sendX(chat_id, ...)` → `ctx.sendX(...)` — no `chat_id` argument
* `parse_mode: "HTML"` → use `format` tagged template with `bold`, `italic`, etc.
* `bot.editMessageText(text, { chat_id, message_id })` → `ctx.editText(text)`

***

## API calls (direct)

Sometimes you need to call the API directly, outside of a handler.

::: code-group

```ts [NTBA]
// Direct API call
await bot.sendMessage(chatId, "Hello from outside a handler!");
await bot.sendPhoto(chatId, "file_id");
await bot.kickChatMember(chatId, userId);
```

```ts [GramIO]
// Direct API call
await bot.api.sendMessage({ chat_id: chatId, text: "Hello from outside a handler!" });
await bot.api.sendPhoto({ chat_id: chatId, photo: "file_id" });
await bot.api.banChatMember({ chat_id: chatId, user_id: userId });
```

:::

**Key changes:**

* `bot.sendX(id, ...)` → `bot.api.sendX({ chat_id: id, ... })` — named parameters
* API method names align with official Telegram Bot API docs

***

## Keyboards

NTBA requires raw JSON. GramIO has fluent keyboard builders.

::: code-group

```ts [NTBA]
// Inline keyboard
bot.sendMessage(msg.chat.id, "Choose:", {
    reply_markup: {
        inline_keyboard: [
            [
                { text: "Yes", callback_data: "yes" },
                { text: "No", callback_data: "no" },
            ],
        ],
    },
});

// Reply keyboard
bot.sendMessage(msg.chat.id, "Choose:", {
    reply_markup: {
        keyboard: [
            [{ text: "Option A" }, { text: "Option B" }],
        ],
        resize_keyboard: true,
    },
});

// Remove keyboard
bot.sendMessage(msg.chat.id, "Removed.", {
    reply_markup: { remove_keyboard: true },
});
```

```ts [GramIO]
import { InlineKeyboard, Keyboard, RemoveKeyboard } from "gramio";

// Inline keyboard
ctx.send("Choose:", {
    reply_markup: new InlineKeyboard()
        .text("Yes", "yes")
        .text("No", "no"),
});

// Reply keyboard
ctx.send("Choose:", {
    reply_markup: new Keyboard()
        .text("Option A")
        .text("Option B")
        .resized(),
});

// Remove keyboard
ctx.send("Removed.", { reply_markup: new RemoveKeyboard() });
```

:::

**Key changes:**

* Replace raw JSON objects with fluent builder classes
* `.row()` to start a new row
* `.resized()` instead of `resize_keyboard: true`
* `new RemoveKeyboard()` instead of `{ remove_keyboard: true }`

***

## Type-safe callback data

In NTBA you parse `query.data` manually with string comparisons or regexes. GramIO has `CallbackData` for structured, type-safe callback data.

::: code-group

```ts [NTBA]
// Building
bot.sendMessage(chat_id, "Choose:", {
    reply_markup: {
        inline_keyboard: [[
            { text: "Item 1", callback_data: "action:1" },
            { text: "Item 2", callback_data: "action:2" },
        ]],
    },
});

// Handling
bot.on("callback_query", (query) => {
    if (query.data?.startsWith("action:")) {
        const id = parseInt(query.data.split(":")[1]);
        bot.sendMessage(query.message!.chat.id, `You picked: ${id}`);
    }
    bot.answerCallbackQuery(query.id);
});
```

```ts [GramIO]
import { CallbackData, InlineKeyboard } from "gramio";

const actionData = new CallbackData("action").number("id");

// Building
ctx.send("Choose:", {
    reply_markup: new InlineKeyboard()
        .text("Item 1", actionData.pack({ id: 1 }))
        .text("Item 2", actionData.pack({ id: 2 })),
});

// Handling
bot.callbackQuery(actionData, (ctx) => {
    ctx.send(`You picked: ${ctx.queryData.id}`);
    //                                  ^? number
});
```

:::

***

## Formatting messages

::: code-group

```ts [NTBA]
bot.sendMessage(chat_id, "<b>Hello!</b> Visit <a href='https://gramio.dev'>GramIO</a>.", {
    parse_mode: "HTML",
});
```

```ts [GramIO]
import { format, bold, link } from "gramio";

ctx.send(format`${bold`Hello!`} Visit ${link("GramIO", "https://gramio.dev")}.`);
```

:::

No `parse_mode` needed — GramIO produces `MessageEntity` arrays automatically.

***

## Session / State management

NTBA has no built-in session system. Common patterns use a `Map` or database directly.

::: code-group

```ts [NTBA]
// Manual state (global Map — does not survive restarts)
const userState = new Map<number, { count: number }>();

bot.on("message", (msg) => {
    const state = userState.get(msg.from!.id) ?? { count: 0 };
    state.count++;
    userState.set(msg.from!.id, state);
    bot.sendMessage(msg.chat.id, `Count: ${state.count}`);
});
```

```ts [GramIO]
import { session } from "@gramio/session";

const bot = new Bot(process.env.BOT_TOKEN as string).extend(
    session({ initial: () => ({ count: 0 }) }),
);

bot.on("message", (ctx) => {
    ctx.session.count++;
    //    ^? { count: number }
    ctx.send(`Count: ${ctx.session.count}`);
});
```

:::

`@gramio/session` supports [storage adapters](/storages) for Redis, databases, and more.

***

## Multi-step conversations

NTBA has no built-in conversation system. A common workaround is tracking a "step" in a Map.

::: code-group

```ts [NTBA]
// Manual step tracking
const userStep = new Map<number, string>();

bot.onText(/\/register/, (msg) => {
    userStep.set(msg.from!.id, "awaiting_name");
    bot.sendMessage(msg.chat.id, "What's your name?");
});

bot.on("message", (msg) => {
    const step = userStep.get(msg.from!.id);
    if (step === "awaiting_name") {
        userStep.delete(msg.from!.id);
        bot.sendMessage(msg.chat.id, `Hello, ${msg.text}!`);
    }
});
```

```ts [GramIO]
import { Scene, scenes } from "@gramio/scenes";
import { session } from "@gramio/session";

const registerScene = new Scene("register")
    .step("message", (ctx) => {
        if (ctx.scene.step.firstTime) return ctx.send("What's your name?");
        return ctx.scene.update({ name: ctx.text });
    })
    .step("message", (ctx) => ctx.send(`Hello, ${ctx.scene.state.name}!`));

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(session())
    .extend(scenes([registerScene]));

bot.command("register", (ctx) => ctx.scene.enter(registerScene));
```

:::

***

## Error handling

::: code-group

```ts [NTBA]
// Wrap every handler manually
bot.on("message", async (msg) => {
    try {
        await riskyOperation();
    } catch (e) {
        console.error(e);
        bot.sendMessage(msg.chat.id, "Something went wrong.");
    }
});

// Handle polling errors
bot.on("polling_error", (error) => {
    console.error("Polling error:", error);
});
```

```ts [GramIO]
// Centralized error handling
bot.onError(({ context, kind, error }) => {
    console.error(kind, error.message);
    if (context.is("message")) context.send("Something went wrong.");
});
```

:::

***

## Webhook

::: code-group

```ts [NTBA]
import TelegramBot from "node-telegram-bot-api";
import express from "express";

const bot = new TelegramBot(process.env.BOT_TOKEN!, { webHook: true });
const app = express();

app.use(express.json());
app.post("/webhook", (req, res) => {
    bot.processUpdate(req.body);
    res.sendStatus(200);
});

app.listen(3000);
bot.setWebHook("https://example.com/webhook");
```

```ts [GramIO]
import { Bot, webhookHandler } from "gramio";
import Fastify from "fastify";

const bot = new Bot(process.env.BOT_TOKEN as string);
const fastify = Fastify();

fastify.post("/webhook", webhookHandler(bot, "fastify"));
fastify.listen({ port: 3000, host: "::" });

// Calls setWebhook on Telegram — does NOT start an HTTP server
bot.start({
    webhook: { url: "https://example.com/webhook" },
});
```

:::

See [all supported frameworks →](/updates/webhook) (Hono, Express, Elysia, Koa, Bun.serve, Deno.serve, node:http)

***

## TypeScript

::: code-group

```ts [NTBA]
import TelegramBot from "node-telegram-bot-api";
// Requires: npm install @types/node-telegram-bot-api

const bot = new TelegramBot(token, { polling: true });

bot.on("message", (msg: TelegramBot.Message) => {
    const text = msg.text; // string | undefined
    // No context methods — must call bot.sendMessage(msg.chat.id, ...)
});
```

```ts [GramIO]
import { Bot } from "gramio";

const bot = new Bot(token)
    .derive(async (ctx) => ({
        user: await db.getUser(ctx.from?.id),
    }));

bot.on("message", (ctx) => {
    ctx.user;   // ✅ fully typed — your custom field
    ctx.text;   // string | undefined
    ctx.send;   // ✅ context method — no chat_id needed
});
```

:::

In NTBA, TypeScript only types the raw Telegram objects. In GramIO, everything flows through the context including custom fields added via `.derive()` and `.decorate()`.

***

## Quick reference

| node-telegram-bot-api | GramIO |
|---|---|
| `new TelegramBot(token, { polling: true })` | `new Bot(token); bot.start()` |
| `bot.on("message", (msg) => ...)` | `bot.on("message", (ctx) => ...)` |
| `bot.sendMessage(msg.chat.id, text)` | `ctx.send(text)` |
| `bot.onText(/regex/, (msg, match) => ...)` | `bot.hears(/regex/, (ctx) => ...)` |
| `bot.on("callback_query", (query) => ...)` | `bot.callbackQuery("data", (ctx) => ...)` |
| `bot.answerCallbackQuery(query.id)` | `ctx.answer()` |
| `bot.sendPhoto(chat_id, file_id)` | `ctx.sendPhoto(file_id)` |
| Raw JSON inline keyboards | `new InlineKeyboard().text(label, data)` |
| Raw JSON reply keyboards | `new Keyboard().text(label).resized()` |
| `{ remove_keyboard: true }` | `new RemoveKeyboard()` |
| Manual state Map | `@gramio/session` |
| Manual step tracking | `@gramio/scenes` |
| `bot.on("polling_error")` | `bot.onError(...)` |
| External `@types/` package | Built-in TypeScript |

---

---
url: 'https://gramio.dev/guides/migration-from-puregram.md'
---

# Migrating from puregram

This guide is for developers with a bot written in [puregram](https://github.com/nitreojs/puregram) who want to move to GramIO. Side-by-side comparisons show what changes.

***

## Why migrate?

Both are TypeScript-native Telegram bot frameworks. Key differences:

| | puregram | GramIO |
|---|---|---|
| Bot init | `new Telegram({ token })` / `.fromToken()` | `new Bot(token)` |
| Handler registration | `bot.updates.on()` | `bot.on()` |
| Starting the bot | `bot.updates.startPolling()` | `bot.start()` |
| Middleware | `bot.updates.use()` | `bot.use()` |
| Type-safe context extension | Manual augmentation | `.derive()` / `.extend()` — automatic |
| Formatting | HTML/MarkdownV2 strings | Tagged template literals → `MessageEntity` |
| `hears` / text matching | `@puregram/hear` plugin | Built-in `bot.hears()` |
| Scaffolding CLI | ❌ | ✅ `npm create gramio` |
| Built-in test utilities | ❌ | ✅ `@gramio/test` |
| Full Telegram API reference | ❌ | ✅ `/telegram/` |
| Multi-runtime (Node/Bun/Deno) | Node.js | Node.js, Bun, Deno |

***

## Installation

::: pm-add gramio
:::

::: pm-remove puregram
:::

***

## Bot initialization

::: code-group

```ts [puregram]
import { Telegram } from "puregram";

// Object form
const bot = new Telegram({ token: process.env.BOT_TOKEN! });

// Factory form
const bot = Telegram.fromToken(process.env.BOT_TOKEN!);

bot.updates.startPolling();
```

```ts [GramIO]
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string);

bot.start();
```

:::

**Key changes:**

* `Telegram` → `Bot`
* `new Telegram({ token })` → `new Bot(token)` (token is a direct argument)
* `bot.updates.startPolling()` → `bot.start()`

***

## Handlers

::: code-group

```ts [puregram]
bot.updates.on("message", (context) => {
    context.reply("Hello!");
});

bot.updates.on("callback_query", (context) => {
    context.answerCallbackQuery("Done!");
});
```

```ts [GramIO]
bot.on("message", (ctx) => {
    ctx.send("Hello!");
});

bot.callbackQuery("my-data", (ctx) => {
    ctx.answer();
});
```

:::

**Key changes:**

* `bot.updates.on()` → `bot.on()`
* `context.reply()` → `ctx.send()`
* `context.answerCallbackQuery()` → `ctx.answer()`

***

## Commands

::: code-group

```ts [puregram]
bot.updates.on("message", (context) => {
    if (context.text === "/start") {
        context.reply("Welcome!");
    }
});
```

```ts [GramIO]
// Built-in command handler
bot.command("start", (ctx) => ctx.send("Welcome!"));
```

:::

GramIO has first-class `.command()` support — no manual text checking needed.

***

## Text matching (hears)

::: code-group

```ts [puregram — @puregram/hear]
import { HearManager } from "@puregram/hear";

const hearManager = new HearManager<MessageContext>();

hearManager.hear(/hello/i, (context) => {
    context.reply("Hey!");
});

bot.updates.on("message", (context, next) =>
    hearManager.middleware(context, next)
);
```

```ts [GramIO — built-in]
// No plugin needed
bot.hears(/hello/i, (ctx) => ctx.send("Hey!"));

// String match
bot.hears("hello", (ctx) => ctx.send("Hey!"));

// Function predicate
bot.hears(
    (ctx) => ctx.text?.startsWith("?"),
    (ctx) => ctx.send("A question!"),
);
```

:::

`hears` is built into GramIO — the `@puregram/hear` plugin is not needed.

***

## Context properties

::: code-group

```ts [puregram]
context.chat        // TelegramChat
context.from        // TelegramUser
context.senderId    // context.from?.id shorthand
context.message     // TelegramMessage
context.text        // message text
context.callbackQuery  // on callback_query updates
```

```ts [GramIO]
ctx.chat            // TelegramChat
ctx.from            // TelegramUser | undefined
ctx.from?.id        // no special shorthand
ctx.message         // TelegramMessage | undefined
ctx.text            // string | undefined
// callback data is top-level on callbackQuery events
```

:::

***

## Middleware

::: code-group

```ts [puregram]
bot.updates.use(async (context, next) => {
    console.log("Before");
    await next();
    console.log("After");
});
```

```ts [GramIO]
bot.use(async (ctx, next) => {
    console.log("Before");
    await next();
    console.log("After");
});
```

:::

**Key change:** `bot.updates.use()` → `bot.use()`

***

## Adding data to context

::: code-group

```ts [puregram — middleware]
// Manual context augmentation via middleware
bot.updates.use(async (context, next) => {
    (context as any).user = await db.getUser(context.from?.id);
    await next();
});

// Must manually type-cast everywhere
const user = (context as any).user;
```

```ts [GramIO — derive()]
// Typed automatically — no casts
const bot = new Bot(token)
    .derive(async (ctx) => ({
        user: await db.getUser(ctx.from?.id),
    }));

bot.on("message", (ctx) => {
    ctx.user; // ✅ fully typed, no cast
});
```

:::

```ts
// Static startup-time data (db connection, config)
const bot = new Bot(token)
    .decorate({ db, redis, config });

bot.on("message", (ctx) => {
    ctx.db; // ✅
});
```

***

## Keyboards

### Inline keyboard

::: code-group

```ts [puregram]
import { Keyboard } from "puregram";

const keyboard = Keyboard.inline([
    [
        Keyboard.textButton({ text: "Yes", payload: "yes" }),
        Keyboard.textButton({ text: "No", payload: "no" }),
    ],
]);

context.reply("Choose:", { reply_markup: keyboard });
```

```ts [GramIO]
import { InlineKeyboard } from "gramio";

const keyboard = new InlineKeyboard()
    .text("Yes", "yes")
    .text("No", "no");

ctx.send("Choose:", { reply_markup: keyboard });
```

:::

### Reply keyboard

::: code-group

```ts [puregram]
import { Keyboard } from "puregram";

const keyboard = Keyboard.keyboard([
    [Keyboard.textButton({ text: "Option A" })],
    [Keyboard.textButton({ text: "Option B" })],
]).resize();

context.reply("Choose:", { reply_markup: keyboard });
```

```ts [GramIO]
import { Keyboard } from "gramio";

const keyboard = new Keyboard()
    .text("Option A")
    .row()
    .text("Option B")
    .resized();

ctx.send("Choose:", { reply_markup: keyboard });
```

:::

***

## Formatting

::: code-group

```ts [puregram]
// HTML — manual escaping required
context.reply(
    "<b>Hello</b> <a href='https://gramio.dev'>GramIO</a>",
    { parse_mode: "HTML" }
);

// MarkdownV2 — complex escaping
context.reply("*Bold* _italic_", { parse_mode: "MarkdownV2" });
```

```ts [GramIO]
import { format, bold, italic, link } from "gramio";

// Tagged template literals — no escaping, no parse_mode
ctx.send(
    format`${bold`Hello`} ${link("GramIO", "https://gramio.dev")}`
);
```

:::

***

## Session

::: code-group

```ts [puregram — @puregram/session]
import { SessionManager } from "@puregram/session";

const sessionManager = new SessionManager();

bot.updates.use(sessionManager.middleware);

bot.updates.on("message", (context) => {
    context.session.count ??= 0;
    context.session.count++;
    context.reply(`Count: ${context.session.count}`);
});
```

```ts [GramIO — @gramio/session]
import { session } from "@gramio/session";

const bot = new Bot(token).extend(
    session({ initial: () => ({ count: 0 }) })
);

bot.on("message", (ctx) => {
    ctx.session.count++;
    //    ^? { count: number } — typed!
    ctx.send(`Count: ${ctx.session.count}`);
});
```

:::

***

## Scenes

::: code-group

```ts [puregram — @puregram/scenes]
import { SceneManager, Scene } from "@puregram/scenes";

const sceneManager = new SceneManager();

const loginScene = new Scene("login");

loginScene.addStep(async (context, next) => {
    await context.reply("Enter your email:");
    await next();
});

loginScene.addStep(async (context) => {
    await context.reply(`Got: ${context.text}`);
});

sceneManager.addScenes([loginScene]);
bot.updates.use(sceneManager.middleware);
```

```ts [GramIO — @gramio/scenes]
import { scenes, Scene } from "@gramio/scenes";
import { session } from "@gramio/session";

const loginScene = new Scene("login")
    .step("message", (ctx) => {
        if (ctx.scene.step.firstTime) return ctx.send("Enter your email:");
        return ctx.scene.update({ email: ctx.text });
    })
    .step("message", (ctx) =>
        ctx.send(`Got: ${ctx.scene.state.email}`)
    );

const bot = new Bot(token)
    .extend(session())
    .extend(scenes([loginScene]));

bot.command("login", (ctx) => ctx.scene.enter(loginScene));
```

:::

***

## Error handling

::: code-group

```ts [puregram]
// Wrap handlers manually
bot.updates.on("message", async (context) => {
    try {
        await riskyOperation();
    } catch (error) {
        context.reply("Something went wrong.");
    }
});
```

```ts [GramIO]
// Global error handler
bot.onError(({ context, error }) => {
    console.error(error);
    if (context.is("message")) context.send("Something went wrong.");
});

// Custom typed errors
class PaymentError extends Error {
    constructor(public reason: string) { super(); }
}

bot
    .error("PAYMENT_FAILED", PaymentError)
    .onError(({ kind, error }) => {
        if (kind === "PAYMENT_FAILED") console.log(error.reason);
    });
```

:::

***

## Webhook

::: code-group

```ts [puregram]
import { Telegram } from "puregram";
import express from "express";

const bot = Telegram.fromToken(token);
const app = express();

app.use(express.json());
app.post("/bot", (req, res) => {
    bot.updates.handleUpdate(req.body);
    res.sendStatus(200);
});

app.listen(3000);
```

```ts [GramIO]
import { Bot, webhookHandler } from "gramio";
import express from "express";

const app = express();
app.use(express.json());
app.post("/webhook", webhookHandler(bot, "express"));
app.listen(3000);

// Tell Telegram where to send updates
bot.start({
    webhook: { url: "https://example.com/webhook" },
});
```

:::

***

## Sending files

::: code-group

```ts [puregram]
import { MediaSource } from "puregram";

context.replyWithPhoto(MediaSource.path("./photo.jpg"));
context.replyWithPhoto(MediaSource.url("https://example.com/photo.jpg"));
context.replyWithPhoto(MediaSource.buffer(buffer, "photo.jpg"));
```

```ts [GramIO]
import { MediaUpload } from "@gramio/files";

ctx.sendPhoto(await MediaUpload.path("./photo.jpg"));
ctx.sendPhoto(await MediaUpload.url("https://example.com/photo.jpg"));
ctx.sendPhoto(await MediaUpload.buffer(buffer, "photo.jpg"));

// Already-uploaded file_id — pass directly
ctx.sendPhoto("AgACAgIAAxk...");
```

:::

***

## Direct API calls

::: code-group

```ts [puregram]
// Via context
await context.telegram.sendMessage({
    chat_id: context.chat.id,
    text: "Hello",
});

// Via bot
await bot.api.sendMessage({
    chat_id: chatId,
    text: "Hello",
});
```

```ts [GramIO]
// Via context
await ctx.api.sendMessage({ chat_id: ctx.chat.id, text: "Hello" });

// Via bot
await bot.api.sendMessage({ chat_id, text: "Hello" });
```

:::

Both use named params — the API shape is the same.

***

## Lifecycle hooks

::: code-group

```ts [puregram]
// Manual setup — no built-in hooks
process.on("SIGINT", () => bot.updates.stopPolling());
```

```ts [GramIO]
bot.onStart(({ info }) => console.log(`@${info.username} started`));
bot.onStop(() => console.log("Shutting down"));

// Graceful shutdown must be set up manually
process.on("SIGINT", () => bot.stop());
process.on("SIGTERM", () => bot.stop());

bot.start();
```

:::

***

## Quick symbol reference

| puregram | GramIO | Notes |
|----------|--------|-------|
| `new Telegram({ token })` | `new Bot(token)` | Direct token arg |
| `Telegram.fromToken(token)` | `new Bot(token)` | Same |
| `bot.updates.on()` | `bot.on()` | Flat, no `.updates` |
| `bot.updates.use()` | `bot.use()` | Flat, no `.updates` |
| `bot.updates.startPolling()` | `bot.start()` | |
| `context.reply()` | `ctx.send()` | |
| `context.senderId` | `ctx.from?.id` | No shorthand |
| `Keyboard.inline([...])` | `new InlineKeyboard()...` | Fluent builder |
| `Keyboard.keyboard([...])` | `new Keyboard()...` | Fluent builder |
| `MediaSource.path()` | `await MediaUpload.path()` | async |
| `@puregram/hear` | `bot.hears()` built-in | No plugin needed |
| `@puregram/session` | `@gramio/session` | |
| `@puregram/scenes` | `@gramio/scenes` | |
| `@puregram/prompt` | `@gramio/prompt` | |
| `parse_mode: "HTML"` | `format\`${bold\`...\`}\`\` | No escaping |

***

## Next steps

* [Get started →](/get-started) — Scaffold a new GramIO project
* [Plugins overview →](/plugins/overview) — Sessions, scenes, i18n and more
* [Cheat Sheet →](/cheat-sheet) — Common patterns at a glance
* [Introduction →](/introduction) — Why GramIO, at a glance

---

---
url: 'https://gramio.dev/guides/migration-from-telegraf.md'
---

# Migrating from Telegraf

This guide is for developers who have a bot written with [Telegraf](https://telegraf.js.org/) and want to switch to GramIO. Both are TypeScript-first middleware-based frameworks — the mental model is similar, but the APIs differ in important ways.

***

## Why migrate?

| | Telegraf | GramIO |
|---|---|---|
| TypeScript plugin typing | Manual interface merging | `.extend()` — types flow automatically |
| Formatting | HTML / MarkdownV2 strings | Tagged template literals → `MessageEntity` |
| Built-in test utilities | ❌ | ✅ `@gramio/test` |
| Full Telegram API reference | ❌ | ✅ `/telegram/` |
| Scaffolding CLI | ❌ | ✅ `npm create gramio` |
| `derive()` auto-typing | Manual context augmentation | ✅ first-class `.derive()` |
| Built-in webhook server | ✅ (via `bot.launch()`) | ❌ (bring your own + `webhookHandler`) |
| Scenes / WizardScene | `Scenes.WizardScene` + `Stage` | `@gramio/scenes` — typed state flow |
| Named API params | Mixed positional/object | All named `{ chat_id, text }` |

***

## Installation

::: pm-add gramio
:::

::: pm-remove telegraf
:::

***

## Bot initialization

::: code-group

```ts [Telegraf]
import { Telegraf } from "telegraf";

const bot = new Telegraf(process.env.BOT_TOKEN!);

bot.launch();
```

```ts [GramIO]
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string);

bot.start();
```

:::

**Key changes:**

* `new Telegraf(token)` → `new Bot(token)`
* `bot.launch()` → `bot.start()`

***

## Handlers

::: code-group

```ts [Telegraf]
// Command
bot.command("start", (ctx) => ctx.reply("Hello!"));

// Text message
bot.on("text", (ctx) => ctx.reply(ctx.message.text));

// Any message
bot.on("message", (ctx) => ctx.reply("Got it!"));

// Hears
bot.hears(/hello/i, (ctx) => ctx.reply("Hey!"));

// Callback query (button press)
bot.action("yes", (ctx) => {
    ctx.answerCbQuery();
    ctx.reply("You said yes!");
});
```

```ts [GramIO]
// Command
bot.command("start", (ctx) => ctx.send("Hello!"));

// Text message
bot.on("message", (ctx) => ctx.send(ctx.text ?? ""));

// Any message
bot.on("message", (ctx) => ctx.send("Got it!"));

// Hears
bot.hears(/hello/i, (ctx) => ctx.send("Hey!"));

// Callback query (button press)
bot.callbackQuery("yes", (ctx) => {
    ctx.answer(); // auto-acknowledges
    ctx.send("You said yes!");
});
```

:::

**Key changes:**

* `ctx.reply()` → `ctx.send()`
* `bot.on("text")` Telegraf filter → use `ctx.text` inside `bot.on("message")`
* `bot.action("data")` → `bot.callbackQuery("data")`
* `ctx.answerCbQuery()` → `ctx.answer()`

***

## Context properties

::: code-group

```ts [Telegraf]
ctx.message          // TelegramMessage | undefined
ctx.message?.text    // string | undefined
ctx.from             // TelegramUser | undefined
ctx.chat             // TelegramChat | undefined
ctx.callbackQuery    // TelegramCallbackQuery | undefined
ctx.update           // raw TelegramUpdate
```

```ts [GramIO]
ctx.message          // TelegramMessage | undefined
ctx.text             // string | undefined  (shorthand on message ctx)
ctx.from             // TelegramUser | undefined
ctx.chat             // TelegramChat | undefined
// (callback_query and inline_query are top-level ctx properties on those events)
```

:::

***

## Sending messages

::: code-group

```ts [Telegraf]
await ctx.reply("Hello!");
await ctx.reply("<b>Hello!</b>", { parse_mode: "HTML" });
await ctx.replyWithPhoto("file_id");
await ctx.telegram.sendMessage(chatId, "Hello from outside!");
```

```ts [GramIO]
await ctx.send("Hello!");

import { format, bold } from "gramio";
await ctx.send(format`${bold`Hello!`}`); // no parse_mode needed

await ctx.sendPhoto("file_id");
await bot.api.sendMessage({ chat_id: chatId, text: "Hello from outside!" });
```

:::

**Key changes:**

* `ctx.reply()` → `ctx.send()`
* `ctx.replyWithPhoto()` → `ctx.sendPhoto()`
* `ctx.telegram.method()` → `bot.api.method({ ...namedParams })`
* No `parse_mode` — use `format` tagged template literals

***

## Direct API calls

::: code-group

```ts [Telegraf]
// From inside a handler
await ctx.telegram.sendMessage(chatId, "Hello!");
await ctx.telegram.sendPhoto(chatId, { source: "./photo.jpg" });
await ctx.telegram.banChatMember(chatId, userId);

// Outside a handler
await bot.telegram.sendMessage(chatId, "Hello!");
```

```ts [GramIO]
// From inside a handler
await ctx.api.sendMessage({ chat_id: chatId, text: "Hello!" });
await ctx.api.sendPhoto({ chat_id: chatId, photo: "file_id" });
await ctx.api.banChatMember({ chat_id: chatId, user_id: userId });

// Outside a handler
await bot.api.sendMessage({ chat_id: chatId, text: "Hello!" });
```

:::

**Key change:** `ctx.telegram` / `bot.telegram` → `ctx.api` / `bot.api` with fully named params.

***

## Keyboards

::: code-group

```ts [Telegraf]
import { Markup } from "telegraf";

// Inline keyboard
ctx.reply("Choose:", Markup.inlineKeyboard([
    [
        Markup.button.callback("Yes ✅", "yes"),
        Markup.button.callback("No ❌", "no"),
    ],
    [Markup.button.url("GitHub", "https://github.com/gramiojs/gramio")],
]));

// Reply keyboard
ctx.reply("Choose:", Markup.keyboard([
    ["Option A", "Option B"],
]).resize());

// Remove keyboard
ctx.reply("Removed.", Markup.removeKeyboard());
```

```ts [GramIO]
import { InlineKeyboard, Keyboard, RemoveKeyboard } from "gramio";

// Inline keyboard
ctx.send("Choose:", {
    reply_markup: new InlineKeyboard()
        .text("Yes ✅", "yes")
        .text("No ❌", "no")
        .row()
        .url("GitHub", "https://github.com/gramiojs/gramio"),
});

// Reply keyboard
ctx.send("Choose:", {
    reply_markup: new Keyboard()
        .text("Option A")
        .text("Option B")
        .resized(),
});

// Remove keyboard
ctx.send("Removed.", { reply_markup: new RemoveKeyboard() });
```

:::

**Key changes:**

* `Markup.inlineKeyboard([...])` → `new InlineKeyboard().text(...).row()...`
* `Markup.keyboard([...]).resize()` → `new Keyboard().text(...).resized()`
* `Markup.removeKeyboard()` → `new RemoveKeyboard()`

***

## Type-safe callback data

::: code-group

```ts [Telegraf]
// Building
ctx.reply("Choose:", Markup.inlineKeyboard([
    [
        Markup.button.callback("Item 1", "action:1"),
        Markup.button.callback("Item 2", "action:2"),
    ],
]));

// Handling
bot.action(/action:(\d+)/, (ctx) => {
    const id = parseInt(ctx.match[1]);
    ctx.reply(`You picked: ${id}`);
    ctx.answerCbQuery();
});
```

```ts [GramIO]
import { CallbackData, InlineKeyboard } from "gramio";

const actionData = new CallbackData("action").number("id");

// Building
ctx.send("Choose:", {
    reply_markup: new InlineKeyboard()
        .text("Item 1", actionData.pack({ id: 1 }))
        .text("Item 2", actionData.pack({ id: 2 })),
});

// Handling
bot.callbackQuery(actionData, (ctx) => {
    ctx.send(`You picked: ${ctx.queryData.id}`);
    //                                  ^? number
});
```

:::

***

## Formatting

::: code-group

```ts [Telegraf]
await ctx.reply(
    "<b>Hello!</b> Visit <a href='https://gramio.dev'>GramIO</a>.",
    { parse_mode: "HTML" }
);
```

```ts [GramIO]
import { format, bold, link } from "gramio";

await ctx.send(
    format`${bold`Hello!`} Visit ${link("GramIO", "https://gramio.dev")}.`
);
```

:::

***

## TypeScript / Adding custom context

In Telegraf you augment the context interface manually and pass it as a generic. In GramIO, `.derive()` and `.extend()` do this automatically with zero boilerplate.

::: code-group

```ts [Telegraf]
// 1. Define your custom context
interface MyContext extends Context {
    session: { count: number };
    isAdmin: boolean;
}

// 2. Pass it as generic to every construct
const bot = new Telegraf<MyContext>(token);

// 3. Register middleware that fills it in
bot.use(session<MyContext>({ ... }));
bot.use(async (ctx, next) => {
    ctx.isAdmin = ctx.from?.id === ADMIN_ID;
    await next();
});

// 4. Use it
bot.on("message", (ctx) => {
    ctx.isAdmin; // boolean — but not statically verified by the compiler
});
```

```ts [GramIO]
// .derive() enriches the context — types flow automatically
const bot = new Bot(token)
    .extend(session({ initial: () => ({ count: 0 }) }))
    .derive((ctx) => ({
        isAdmin: ctx.from?.id === ADMIN_ID,
    }));

bot.on("message", (ctx) => {
    ctx.isAdmin; // ✅ boolean — inferred by the compiler
    ctx.session; // ✅ { count: number } — from .extend(session(...))
});
```

:::

***

## Session

::: code-group

```ts [Telegraf]
import { session } from "telegraf/session";

interface SessionData { count: number }
interface MyContext extends Context { session: SessionData }

const bot = new Telegraf<MyContext>(token);
bot.use(session<MyContext>({ defaultSession: () => ({ count: 0 }) }));

bot.command("count", (ctx) => {
    ctx.session.count++;
    ctx.reply(`Count: ${ctx.session.count}`);
});
```

```ts [GramIO]
import { session } from "@gramio/session";

const bot = new Bot(token).extend(
    session({ initial: () => ({ count: 0 }) })
);

bot.command("count", (ctx) => {
    ctx.session.count++;
    //    ^? { count: number }
    ctx.send(`Count: ${ctx.session.count}`);
});
```

:::

***

## Scenes / WizardScene

::: code-group

```ts [Telegraf]
import { Scenes, session } from "telegraf";

const wizard = new Scenes.WizardScene(
    "register",
    async (ctx) => {
        await ctx.reply("What's your name?");
        return ctx.wizard.next();
    },
    async (ctx) => {
        const name = ctx.message && "text" in ctx.message ? ctx.message.text : "";
        await ctx.reply(`Hello, ${name}!`);
        return ctx.scene.leave();
    },
);

const stage = new Scenes.Stage([wizard]);
bot.use(session());
bot.use(stage.middleware());

bot.command("register", (ctx) => ctx.scene.enter("register"));
```

```ts [GramIO]
import { Scene, scenes } from "@gramio/scenes";
import { session } from "@gramio/session";

const registerScene = new Scene("register")
    .step("message", (ctx) => {
        if (ctx.scene.step.firstTime) return ctx.send("What's your name?");
        return ctx.scene.update({ name: ctx.text });
    })
    .step("message", (ctx) =>
        ctx.send(`Hello, ${ctx.scene.state.name}!`)
    );

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(session())
    .extend(scenes([registerScene]));

bot.command("register", (ctx) => ctx.scene.enter(registerScene));
```

:::

**Key changes:**

* No `Stage` class — pass scenes directly to `scenes([...])`
* No `ctx.wizard.next()` — steps advance automatically when a matching update arrives
* State is typed: `ctx.scene.state` carries what you passed to `ctx.scene.update()`
* Leave a scene with `ctx.scene.leave()` (or it ends after the last step)

***

## Error handling

::: code-group

```ts [Telegraf]
// Per-handler try/catch
bot.command("start", async (ctx) => {
    try {
        await riskyOperation();
    } catch (e) {
        await ctx.reply("Something went wrong.");
    }
});

// Global error handler
bot.catch((err, ctx) => {
    console.error(err);
    ctx.reply("An error occurred.");
});
```

```ts [GramIO]
// Centralized error handler
bot.onError(({ context, kind, error }) => {
    console.error(kind, error.message);
    if (context.is("message")) context.send("Something went wrong.");
});

// Custom typed errors
class NoRights extends Error {
    constructor(public role: "admin" | "moderator") { super(); }
}

const bot = new Bot(process.env.BOT_TOKEN as string)
    .error("NO_RIGHTS", NoRights)
    .onError(({ kind, error, context }) => {
        if (kind === "NO_RIGHTS" && context.is("message"))
            context.send(`You need the «${error.role}» role.`);
    });
```

:::

**Key changes:**

* `bot.catch((err, ctx) => ...)` → `bot.onError(({ context, kind, error }) => ...)`
* Errors can be given typed names with `.error("KIND", ErrorClass)`

***

## Graceful shutdown

::: code-group

```ts [Telegraf]
// Built into bot.launch()
process.once("SIGINT", () => bot.stop("SIGINT"));
process.once("SIGTERM", () => bot.stop("SIGTERM"));
```

```ts [GramIO]
// Wire up manually
process.on("SIGINT", () => bot.stop());
process.on("SIGTERM", () => bot.stop());
```

:::

***

## Webhook

Telegraf has a built-in HTTP server via `bot.launch({ webhook: { ... } })`. GramIO does not — you bring your own framework and use `webhookHandler`.

::: code-group

```ts [Telegraf]
// Built-in webhook server
bot.launch({
    webhook: {
        domain: "https://example.com",
        port: 3000,
    },
});

// Or manual with express
import express from "express";
const app = express();
app.use(express.json());
app.use(bot.webhookCallback("/webhook"));
app.listen(3000);
```

```ts [GramIO]
import { Bot, webhookHandler } from "gramio";
import Fastify from "fastify";

const bot = new Bot(process.env.BOT_TOKEN as string);
const fastify = Fastify();

fastify.post("/webhook", webhookHandler(bot, "fastify"));
fastify.listen({ port: 3000, host: "::" });

// Calls setWebhook on Telegram — does NOT start an HTTP server
bot.start({
    webhook: { url: "https://example.com/webhook" },
});
```

:::

See [all supported frameworks →](/updates/webhook) (Hono, Express, Elysia, Koa, Bun.serve, Deno.serve, node:http)

***

## Middleware

Both frameworks use `(ctx, next) => ...` middleware chains.

::: code-group

```ts [Telegraf]
bot.use(async (ctx, next) => {
    console.log("Before:", ctx.updateType);
    await next();
    console.log("After");
});
```

```ts [GramIO]
bot.use(async (ctx, next) => {
    console.log("Before:", ctx.update);
    await next();
    console.log("After");
});
```

:::

The shape is identical — `bot.use()` works the same way.

***

## Quick reference

| Telegraf | GramIO |
|---|---|
| `new Telegraf(token)` | `new Bot(token)` |
| `bot.launch()` | `bot.start()` |
| `ctx.reply(text)` | `ctx.send(text)` |
| `ctx.replyWithPhoto(file_id)` | `ctx.sendPhoto(file_id)` |
| `ctx.telegram.sendMessage(id, text)` | `ctx.api.sendMessage({ chat_id: id, text })` |
| `bot.telegram.sendMessage(id, text)` | `bot.api.sendMessage({ chat_id: id, text })` |
| `bot.action("data", handler)` | `bot.callbackQuery("data", handler)` |
| `ctx.answerCbQuery()` | `ctx.answer()` |
| `Markup.inlineKeyboard([...])` | `new InlineKeyboard().text(...)` |
| `Markup.keyboard([...]).resize()` | `new Keyboard().text(...).resized()` |
| `Markup.removeKeyboard()` | `new RemoveKeyboard()` |
| `interface MyContext extends Context {}` | `.derive(ctx => ({...}))` |
| `bot.use(session({...}))` | `.extend(session({...}))` |
| `new Scenes.WizardScene(...)` + `Stage` | `new Scene(...) ` + `scenes([...])` |
| `bot.catch((err, ctx) => ...)` | `bot.onError(({ error, context }) => ...)` |
| Built-in webhook server | `webhookHandler(bot, "framework")` + your server |
| HTML / MarkdownV2 strings | `format\`${bold\`text\`}\`\` |

---

---
url: 'https://gramio.dev/hooks/on-error.md'
---

# onError (Error Handling)

Errors can occur in middleware, and we need to handle them.
That's exactly what the `onError` hook is designed for.

```ts twoslash
import { Bot } from "gramio";

const bot = new Bot("");
// ---cut---

bot.on("message", () => {
    bot.api.sendMessage({
        chat_id: "@not_found",
        text: "Chat not exists....",
    });
});

bot.onError(({ context, kind, error }) => {
    if (context.is("message")) return context.send(`${kind}: ${error.message}`);
});
```

### Add hook only to specified contexts

```ts
bot.onError("message", ({ context, kind, error }) => {
    return context.send(`${kind}: ${error.message}`);
});
// or array
bot.onError(["message", "message_reaction"], ({ context, kind, error }) => {
    return context.send(`${kind}: ${error.message}`);
});
```

## Error kinds

### Custom

You can catch an error of a certain class inherited from Error.

```ts twoslash
import { Bot, format, bold } from "gramio";
// ---cut---
export class NoRights extends Error {
    needRole: "admin" | "moderator";

    constructor(role: "admin" | "moderator") {
        super();
        this.needRole = role;
    }
}

const bot = new Bot(process.env.BOT_TOKEN as string)
    .error("NO_RIGHTS", NoRights)
    .onError("message", ({ context, kind, error }) => {
        if (kind === "NO_RIGHTS")
            return context.send(
                format`You don't have enough rights! You need to have a «${bold(
                    error.needRole
                    //    ^^^^^^^^
                )}» role.`
            );
    });

bot.on("message", (context) => {
    if (context.text === "ban") throw new NoRights("admin");
});
```

> \[!IMPORTANT]
> We recommend following the **convention** of naming error kinds in **SCREAMING\_SNAKE\_CASE**

### Telegram

This error is the result of a failed request to the Telegram Bot API.

```ts twoslash
import { Bot } from "gramio";

const bot = new Bot("");
// ---cut---
bot.onError(({ context, kind, error }) => {
    if (kind === "TELEGRAM" && error.method === "sendMessage") {
        error.params; // is sendMessage params
    }
});
```

### Unknown

This error is any unknown error, whether it's your custom class or just a standard Error.

```ts twoslash
import { Bot } from "gramio";

const bot = new Bot("");
// ---cut---
bot.onError(({ context, kind, error }) => {
    if (kind === "UNKNOWN") {
        console.log(error.message);
    }
});
```

---

---
url: 'https://gramio.dev/hooks/on-response.md'
---

# onResponse

This hook is called `after receiving a successful response` from the Telegram Bot API.

## Parameters

Object with:

* method - API method name
* params - API method parameters
* response - response data

## Example

```ts twoslash
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string).onResponse((context) => {
    console.log("Response for", context.method, context.response);
});
```

### Add hook only to specified API methods

```ts
bot.onResponse("sendMessage", (context) => {
    console.log("Response for sendMessage", context.response);
});
// or array
bot.onResponse(["sendMessage", "sendPhoto"], (context) => {
    console.log("Response for", context.method, context.response);
});
```

---

---
url: 'https://gramio.dev/hooks/on-response-error.md'
---

# onResponseError

This hook is called `after receiving an error response` from the Telegram Bot API.

## Parameters

[TelegramError](https://jsr.io/@gramio/core@latest/doc/~/TelegramError)

## Example

```ts twoslash
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string).onResponseError(
    (context) => {
        console.log("Error for", context.method, context.message);
    }
);
```

### Add hook only to specified API methods

```ts
bot.onResponseError("sendMessage", (context) => {
    console.log("Error for sendMessage", context.message);
});
// or array
bot.onResponseError(["sendMessage", "sendPhoto"], (context) => {
    console.log("Error for", context.method, context.message);
});
```

---

---
url: 'https://gramio.dev/hooks/on-start.md'
---

# onStart

This hook is called when the bot `starts`.

## Parameters

```ts
{
		plugins: string[];
		info: TelegramUser;
		updatesFrom: "webhook" | "long-polling";
}
```

* plugins - list of plugins
* info - bot account info
* updatesFrom - webhook/polling

## Example

```ts twoslash
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string).onStart(
    ({ plugins, info, updatesFrom }) => {
        console.log(`plugin list - ${plugins.join(", ")}`);
        console.log(`bot username @${info.username}`);
        console.log(`updates from ${updatesFrom}`);
    }
);

bot.start();
```

---

---
url: 'https://gramio.dev/hooks/on-stop.md'
---

# onStop

This hook is called when the bot is stopped.

## Parameters

```ts
{
		plugins: string[];
		info: TelegramUser;
}
```

* plugins - list of plugins
* info - bot account info

## Example

```ts twoslash
// @noErrors
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string).onStop(
    ({ plugins, info }) => {
        console.log(`plugin list - ${plugins.join(", ")}`);
        console.log(`bot username @${info.username}`);
    }
);

bot.start();
bot.stop();
```

---

---
url: 'https://gramio.dev/plugins/official/opentelemetry.md'
---
# OpenTelemetry

[![npm](https://img.shields.io/npm/v/@gramio/opentelemetry?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/opentelemetry)
[![JSR](https://jsr.io/badges/@gramio/opentelemetry)](https://jsr.io/@gramio/opentelemetry)
[![JSR Score](https://jsr.io/badges/@gramio/opentelemetry/score)](https://jsr.io/@gramio/opentelemetry)

Distributed tracing for GramIO via the OpenTelemetry API. Each incoming update becomes a root span, and each Telegram API call becomes a child span. Works with any OTEL-compatible backend (Jaeger, Grafana Tempo, Axiom, etc.) and integrates with Elysia webhooks.

### Installation

::: pm-add @gramio/opentelemetry
:::

### Usage

```typescript
import { Bot } from "gramio";
import { opentelemetryPlugin } from "@gramio/opentelemetry";

const bot = new Bot(process.env.BOT_TOKEN!)
    .extend(opentelemetryPlugin({
        recordApiParams: true,
    }))
    .command("start", (context) => context.send("Hello!"));

await bot.start();
```

### Trace Hierarchy

Each update produces a trace tree like the following:

```
gramio.update.message (CONSUMER)
  ├── telegram.api/sendMessage (CLIENT)
  ├── telegram.api/deleteMessage (CLIENT)
  └── custom spans via record()
```

## Methods

### `record(name, fn)`

Creates a custom child span inside the current update trace:

```typescript
bot.command("heavy", async (context) => {
    await context.record("fetch-data", async () => {
        // expensive work tracked as its own span
    });
});
```

### `getCurrentSpan()`

Returns the active OpenTelemetry span for the current update:

```typescript
bot.on("message", (context) => {
    const span = context.getCurrentSpan();
    span?.addEvent("custom-event");
});
```

### `setAttributes(attrs)`

Adds custom attributes to the current span:

```typescript
bot.command("order", (context) => {
    context.setAttributes({
        "order.id": orderId,
        "order.total": total,
    });
});
```

---

---
url: 'https://gramio.dev/plugins/official/pagination.md'
---

# Pagination

[![npm](https://img.shields.io/npm/v/@gramio/pagination?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/pagination)
[![npm downloads](https://img.shields.io/npm/dw/@gramio/pagination?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/pagination)
[![JSR](https://jsr.io/badges/@gramio/pagination)](https://jsr.io/@gramio/pagination)
[![JSR Score](https://jsr.io/badges/@gramio/pagination/score)](https://jsr.io/@gramio/pagination)

A fluent, chainable API for creating **paginated inline keyboard menus** in Telegram bots. Handles data fetching, keyboard generation, navigation buttons, page info, and item selection callbacks.

> \[!WARNING]
> This package is in WIP stage — the API may change.

## Installation

::: pm-add @gramio/pagination
:::

> \[!IMPORTANT]
> You must override `@gramio/callback-data` version in your `package.json`:
>
> ```json
> {
>     "overrides": {
>         "@gramio/callback-data": "^0.0.11"
>     }
> }
> ```

## Usage

```ts
import { Bot } from "gramio";
import { Pagination } from "@gramio/pagination";
import { paginationFor } from "@gramio/pagination/plugin";

const data = [
    { id: 1, title: "test" },
    { id: 2, title: "test2" },
    { id: 3, title: "test3" },
    { id: 4, title: "test4" },
    { id: 5, title: "test5" },
];

const paginationTest = new Pagination("test", async ({ offset, limit }) => {
    return data.slice(offset, offset + limit);
})
    .count(() => Promise.resolve(data.length))
    .item((x) => ({
        title: x.title,
        id: x.id,
    }))
    .onSelect(({ id, context }) => {
        return context.editText(`Selected ${id}`, {
            reply_markup: context.message?.replyMarkup?.payload,
        });
    })
    .limit(2)
    .columns(2)
    .withFirstLastPage()
    .withPageInfo(
        ({ totalPages, currentPage }) => `${currentPage} / ${totalPages}`
    );

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(paginationFor([paginationTest]))
    .command("start", async (ctx) =>
        ctx.reply("Hello", {
            reply_markup: await paginationTest.getKeyboard(0),
        })
    )
    .onStart(console.log);

await bot.start();
```

## API

### `new Pagination(name, dataFunction)`

Create a pagination instance.

* `name` — unique identifier (used as callback data prefix)
* `dataFunction` — `async ({ offset, limit }) => Data[]` — fetches one page of items

### Chainable methods

| Method | Description |
|---|---|
| `.limit(count)` | Items per page (default: `10`) |
| `.columns(count)` | Button columns in the keyboard grid |
| `.count(func)` | `async () => number` — total item count for full page info |
| `.item(func)` | `(data) => { title, id }` — map each item to a button |
| `.onSelect(callback)` | `({ id, context }) => void` — handler for item button taps |
| `.withPageInfo(format)` | `({ totalPages, currentPage }) => string` — page info button text |
| `.withFirstLastPage()` | Add ⏮️/⏭️ first/last page buttons |
| `.wrapKeyboard(func)` | Post-process the keyboard to add extra buttons |
| `.selectCallbackData(func)` | Override callback data for selection buttons |

### Getting the keyboard

```ts
// Get just the keyboard
const keyboard = await pagination.getKeyboard(offset);

// Get keyboard + fetched data + pagination info
const { keyboard, data, pagination: info } = await pagination.getKeyboardWithData(offset);

// Get data + pagination info without keyboard
const { data, pagination: info } = await pagination.getDataWithPaginationInfo(offset);
```

### `paginationFor(paginationList)`

GramIO plugin that routes `callback_query` events to the correct `Pagination` instance.

```ts
import { paginationFor } from "@gramio/pagination/plugin";

const bot = new Bot("")
    .extend(paginationFor([pagination1, pagination2]));
```

## Pagination strategies

### Without `.count()` (limit+1)

Fetches `limit + 1` items to detect if there's a next page. No total pages or current page info.

### With `.count()`

Runs count and data queries **in parallel**. Enables `.withPageInfo()` and `.withFirstLastPage()` features.

## Navigation buttons

| Button | Condition |
|---|---|
| ⏮️ First page | `.withFirstLastPage()` + has previous |
| ⬅️ Previous | has previous page |
| Page info | `.withPageInfo()` + `.count()` set |
| ➡️ Next | has next page |
| ⏭️ Last page | `.withFirstLastPage()` + has next |

---

---
url: 'https://gramio.dev/plugins/official/posthog.md'
---
# PostHog

[![npm](https://img.shields.io/npm/v/@gramio/posthog?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/posthog)
[![JSR](https://jsr.io/badges/@gramio/posthog)](https://jsr.io/@gramio/posthog)
[![JSR Score](https://jsr.io/badges/@gramio/posthog/score)](https://jsr.io/@gramio/posthog)

A plugin that conveniently wraps the [PostHog](https://posthog.com/) client. Automatically catches errors (including `senderId` and `chatId` in them). Provides methods with pre-bound distinctId (as `from.id`).

You can use [PostHog Cloud free tier](https://posthog.com/pricing) or [self-hosted](https://posthog.com/docs/advanced/self-hosting).

![PostHog](/posthog.png)

### Installation

::: pm-add @gramio/posthog
:::

### Usage

```typescript
import { PostHog } from "posthog-node";
import { posthogPlugin } from "@gramio/posthog";
import { Bot } from "gramio";

const posthog = new PostHog(process.env.POSTHOG_API_KEY!, {
    host: process.env.POSTHOG_HOST,
});

const bot = new Bot(process.env.BOT_TOKEN!)
    .extend(posthogPlugin(posthog))
    .on("message", (context) => {
        context.capture("message", {
            text: context.message.text,
        });

        throw new Error("Will be caught by PostHog");
    });

await bot.start();
```

## Methods

### `capture(event: string, properties?: Record<string, unknown>)`

Captures events and sends them to PostHog along with `senderId`.

```typescript
context.capture("message", {
    text: context.message.text,
});
```

### Feature Flags

#### `isEnabled(feature: string, options?: IsFeatureEnabledOptions)`

Checks if a feature flag is enabled for the current user.

```typescript
const isEnabled = await context.featureFlags.isEnabled("beta-feature", {
    groups: { organization: "org_id" },
});
// Returns boolean
```

#### `getPayload(feature: string, value?: GetFeatureFlagPayloadValue, options?: GetFeatureFlagPayloadOptions)`

Gets the payload (additional data) for a feature flag.

```typescript
const payload = await context.featureFlags.getPayload("pricing-page", {
    sendEmail: true,
});
// Returns any | undefined
```

#### `get(feature: string, options?: GetFeatureFlagOptions)`

Gets complete information about a feature flag.

```typescript
const flag = await context.featureFlags.get("new-onboarding", {
    personProperties: { plan: "pro" },
});
// Returns boolean | string | number | Record<string, any>
```

#### `getAll(options?: GetAllFlagsOptions)`

Gets all feature flags for the user.

```typescript
const allFlags = await context.featureFlags.getAll({
    groups: { company: "acme" },
});
// Returns Record<string, boolean | string | number>
```

#### `getAllPayload(options?: GetAllFlagsPayloadOptions)`

Gets all flags along with their payloads.

```typescript
const flagsWithPayloads = await context.featureFlags.getAllPayload({
    personProperties: { country: "US" },
});
/* Returns:
{
  flags: Record<string, boolean | string | number>
  payloads: Record<string, any>
} */
```

---

---
url: 'https://gramio.dev/hooks/pre-request.md'
---

# preRequest

This hook is called before sending a request to the Telegram Bot API (allowing you to modify the parameters being sent).

## Parameters

* method - API method name
* params - API method parameters

> \[!IMPORTANT]
> You must return the context from the hook handler!

## Example

```ts twoslash
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string).preRequest((context) => {
    if (context.method === "sendMessage") {
        context.params.text = "changed parameters";
    }

    return context;
});

bot.start();
```

### Add hook only to specified API methods

```ts
bot.preRequest("sendMessage", (context) => {
    context.params.text = "modified text";

    return context;
});
// or array
bot.preRequest(["sendMessage", "sendPhoto"], (context) => {
    if (context.method === "sendMessage") {
        context.params.text = "modified text";
    } else {
        context.params.caption = "this is a photo caption from sendPhoto method";
    }

    return context;
});
```

---

---
url: 'https://gramio.dev/plugins/official/prompt.md'
---

# Prompt Plugin

[![npm](https://img.shields.io/npm/v/@gramio/prompt?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/prompt)
[![JSR](https://jsr.io/badges/@gramio/prompt)](https://jsr.io/@gramio/prompt)
[![JSR Score](https://jsr.io/badges/@gramio/prompt/score)](https://jsr.io/@gramio/prompt)

A plugin that provides [Prompt](#prompt) and [Wait](#wait) methods

> \[!NOTE]
> We recommend considering `scenes` instead. Please see the [comparison of `prompt` and `scenes`](/plugins/official/scenes#vs-prompt)

### Installation

::: pm-add @gramio/prompt
:::

## Usage

```ts
import { Bot, format, bold } from "gramio";
import { prompt } from "@gramio/prompt";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(prompt())
    .command("start", async (context) => {
        const answer = await context.prompt(
            "message",
            format`What's your ${bold`name`}?`
        );

        return context.send(`✨ Your name is ${answer.text}`);
    })
    .onStart(console.log);

bot.start();
```

## Prompt

### Prompt with text + params

```ts
const answer = await context.prompt("What's your name?");
// or with SendMessageParams
const answer = await context.prompt("True or false?", {
    reply_markup: new Keyboard().text("true").row().text("false"),
});
```

answer is `MessageContext` or `CallbackQueryContext`

### Prompt with text + params and the specified event

```ts
const answer = await context.prompt("message", "What's your name?");

const answer = await context.prompt("callback_query", "True or false?", {
    reply_markup: new InlineKeyboard()
        .text("true", "true")
        .row()
        .text("false", "false"),
});
```

answer is `CallbackQueryContext`

### Validation

You can define a handler in params to validate the user's answer.
If handler returns false, the message will be repeated.

```ts
const answer = await context.prompt(
    "message",
    "Enter a string that contains russian letter",
    {
        validate: (context) => /[а-яА-Я]/.test(context.text),
        //... and some SendMessageParams
    }
);
```

### Transform

```ts
const name = await context.prompt(
    "message",
    format`What's your ${bold`name`}?`,
    {
        transform: (context) => context.text || context.caption || "",
    }
);
```

name is `string`

## Wait

### Wait for the next event from the user

```ts
const answer = await context.wait();
```

answer is `MessageContext` or `CallbackQueryContext`

### Wait for the next event from the user ignoring events not listed

```ts
const answer = await context.wait("message");
```

answer is `CallbackQueryContext`

### Wait for the next event from the user ignoring non validated answers

You can define a handler in params to validate the user's answer.
If handler return `false`, the **message** will be ignored

```ts
const answer = await context.wait((context) => /[а-яА-Я]/.test(context.text));
// or combine with event
const answer = await context.wait("message", (context) =>
    /[а-яА-Я]/.test(context.text)
);
```

### Wait for the next event from the user ignoring non validated answers with transformer

You can define a handler in params to **transform** the user's answer.

```ts
const answer = await context.wait((context) => /[а-яА-Я]/.test(context.text));
// or combine with event
const answer = await context.wait("message", {
    validate: (context) => /[а-яА-Я]/.test(context.text),
    transform: (context) => c.text || "",
});
```

answer is `string`

## waitWithAction

This function is similar to `wait` but allows executing an action while waiting for an event and get both results.

```ts
const [answer, sentMessage] = await context.waitWithAction(
    "message",
    () => context.send("Please enter your name"),
    {
        validate: (ctx) => !!ctx.text,
        transform: (ctx) => ctx.text.toUpperCase(),
        onValidateError: "Please enter a valid name!",
    }
);

// answer has type `string`
// sentMessage has type `MessageContext`
```

## Timeout

Allows setting a response timeout. After timeout expiration, a `PromptCancelError` (timeout) error will be thrown (based on `timeoutStrategy`). The `timeout` (**in milliseconds**) can be passed in any method's options.

```ts
new Bot()
    .extend(
        prompt({
            timeoutStrategy: "on-timer", // or "on-answer" (default)
        })
    )
    .onError("message", ({ error, kind, context }) => {
        if (kind === "prompt-cancel") {
            // Currently only contains timeout type of error, but this will change
            return context.send("Response time expired :(");
        }

        console.error(error);

        return context.send("An error occurred");
    })
    .command("start", async (context) => {
        const [answer, sentMessage] = await context.waitWithAction(
            "message",
            () => context.send("Please enter your name"),
            {
                timeout: 10_000, // 10 seconds
            }
        );

        return Promise.all([
            sentMessage.delete(),
            context.send(`Thank you, ${answer.text}!`),
        ]);
    });
```

## Configuration

```ts
import { prompt, type PromptsType } from "@gramio/prompt";

const mySharedMap: PromptsType = new Map();

new Bot().extend(
    prompt({
        timeoutStrategy: "on-timer",
        defaults: {
            timeout: 30_000, // 30 seconds
            validate: (ctx) => ctx.hasText(),
            transform: (ctx) => ctx.text.toUpperCase(),
            onValidateError: "Validation failed. Please try again.",
        },
        map: mySharedMap,
    })
);
```

### timeoutStrategy

Controls how `Timeout` error is triggered:

* `"on-answer"` (**default**) - `Timeout` error occurs if user sends message AFTER timeout expiration
* `"on-timer"` - `Timeout` error occurs immediately when timer expires via `setTimeout`

### defaults

Allows setting default values for methods.

### map

Enables providing a custom Map for state storage. This allows modifying it from anywhere.

---

---
url: 'https://gramio.dev/plugins/official/rate-limiter.md'
---
# Rate Limiter

[![npm](https://img.shields.io/npm/v/@gramio/rate-limit?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/rate-limit)

`@gramio/rate-limit` protects your bot handlers from spam and abuse using **sliding-window rate limiting**. Unlike a manual `if (!await ctx.rateLimit(...)) return` pattern, this plugin uses GramIO's **macro system** — handlers declare their limit inline as an options object. No boilerplate, no clutter.

### Installation

::: pm-add @gramio/rate-limit
:::

### Usage

```ts
import { Bot } from "gramio";
import { rateLimit } from "@gramio/rate-limit";

const bot = new Bot(process.env.BOT_TOKEN!)
    .extend(
        rateLimit({
            onLimitExceeded: async (ctx) => {
                if (ctx.is("message")) await ctx.reply("Too many requests, slow down!");
            },
        }),
    );

// Each handler declares its own throttle limits via the options object:
bot.command("pay", (ctx) => {
    // process payment...
}, { rateLimit: { limit: 3, window: 60 } });

bot.command("help", (ctx) => ctx.reply("Here is the help text"), {
    rateLimit: {
        id: "help",          // explicit key — defaults to event type + user id
        limit: 20,
        window: 60,
        onLimitExceeded: (ctx) => ctx.reply("Too many /help requests!"),
    },
});

await bot.start();
```

### Custom storage

The plugin ships with **in-memory storage** out of the box (no external dependencies needed for development). For production, plug in any `@gramio/storages`-compatible adapter:

::: code-group

```ts [Redis]
import { rateLimit } from "@gramio/rate-limit";
import { redisStorage } from "@gramio/storage-redis";
import { Redis } from "ioredis";

const bot = new Bot(process.env.BOT_TOKEN!)
    .extend(
        rateLimit({
            storage: redisStorage(new Redis()),
            onLimitExceeded: async (ctx) => {
                if (ctx.is("message")) await ctx.reply("Slow down!");
            },
        }),
    );
```

```ts [In-memory (default)]
import { rateLimit } from "@gramio/rate-limit";
import { inMemoryStorage } from "@gramio/storage";

const bot = new Bot(process.env.BOT_TOKEN!)
    .extend(
        rateLimit({
            storage: inMemoryStorage(), // explicit, same as default
        }),
    );
```

:::

## API

### `rateLimit(options?)`

Returns a GramIO plugin that registers the `rateLimit` macro.

| Option | Type | Description |
|---|---|---|
| `storage` | `Storage` | Key-value storage adapter. Default: in-memory |
| `key` | `(ctx) => string` | Custom key function. Default: `"${eventType}:${from.id}"` |
| `onLimitExceeded` | `(ctx) => unknown` | Default callback when limit is exceeded |

### Per-handler options (`rateLimit` macro)

Pass as the third argument to any handler method:

```ts
bot.command("pay", handler, {
    rateLimit: {
        id?: string;           // Key override. Defaults to eventType:userId
        limit: number;         // Max requests per window
        window: number;        // Window size in seconds
        onLimitExceeded?: (ctx) => unknown; // Override global callback
    }
});
```

| Field | Type | Default | Description |
|---|---|---|---|
| `id` | `string` | event type + user id | Custom rate limit key |
| `limit` | `number` | — | Maximum allowed requests |
| `window` | `number` | — | Window size in seconds |
| `onLimitExceeded` | function | global option | Per-handler override callback |

---

---
url: 'https://gramio.dev/keyboards/remove-keyboard.md'
---

# Remove Keyboard

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 (see [ReplyKeyboardMarkup](https://core.telegram.org/bots/api/#replykeyboardmarkup)).

See also [API Reference](https://jsr.io/@gramio/keyboards/doc/~/RemoveKeyboard).

## Import

### With GramIO

```ts twoslash
import { RemoveKeyboard } from "gramio";
```

### Without GramIO

```ts twoslash
import { RemoveKeyboard } from "@gramio/keyboards";
```

## Options ([Documentation](https://core.telegram.org/bots/api/#replykeyboardremove))

These parameters are responsible for the settings of the removal buttons

### selective

Use this parameter if you want to remove the keyboard for specific users only.

Targets:

1. users that are @mentioned in the
   *text* of the [Message](https://core.telegram.org/bots/api/#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.

Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.

```ts twoslash
import { RemoveKeyboard } from "@gramio/keyboards";
// ---cut---
new RemoveKeyboard().selective(); // to enable
new RemoveKeyboard().selective(false); // to disable
```

---

---
url: 'https://gramio.dev/keyboards/keyboard.md'
---

# Keyboard

This keyboard is shown under the input field and also known as Reply/Custom Keyboard.
Represents a [custom keyboard](https://core.telegram.org/bots/features#keyboards) with reply options (see [Introduction to bots](https://core.telegram.org/bots/features#keyboards) for details and examples).

See also [API Reference](https://jsr.io/@gramio/keyboards/doc/~/Keyboard)

## Import

### With GramIO

```ts twoslash
import { Keyboard } from "gramio";
```

### Without GramIO

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
```

## Buttons ([Documentation](https://core.telegram.org/bots/api/#keyboardbutton))

Buttons are methods that assemble a keyboard for you.

### text

Text button. It will be sent as a message when the button is pressed

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().text("some button text");
```

### requestUsers

Request users button. Pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a `users_shared` service message. Available in private chats only. `Second parameter` is signed 32-bit identifier of the request that will be received back in the [UsersShared](https://core.telegram.org/bots/api/#usersshared) object. Must be unique within the message

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().requestUsers("some button text", 228, {
    user_is_premium: true,
});
```

More about options in [documentation](https://core.telegram.org/bots/api/#keyboardbuttonrequestusers)

### requestChats

Request users button. Pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a `chat_shared` service message. Available in private chats only. `Second parameter` is signed 32-bit identifier of the request, which will be received back in the [ChatShared](https://core.telegram.org/bots/api/#chatshared) object. Must be unique within the message

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().requestChat("gramio", 255, {
    chat_is_forum: true,
});
```

> \[!WARNING]
> By default, the `chat_is_channel` parameter is false!

More about options in [documentation](https://core.telegram.org/bots/api/#keyboardbuttonrequestchat)

### requestPoll

Request poll button. Pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a `users_shared` service message. Available in private chats only.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().requestPoll("some button text", "quiz");
```

More about options in [documentation](https://core.telegram.org/bots/api/#keyboardbuttonpolltype)

### requestLocation

Request user's location button. The user's current location will be sent when the button is pressed. Available in private chats only.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().requestLocation("some button text");
```

### requestContact

Request contact button. The user's phone number will be sent as a contact when the button is pressed. Available in private chats only.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().requestContact("some button text");
```

### webApp

webApp button. Described [Web App](https://core.telegram.org/bots/webapps) will be launched when the button is pressed. The Web App will be able to send a `web_app_data` service message. Available in private chats only.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().webApp("some button text", "https://...");
```

## Button Styling

Since `@gramio/keyboards` **1.3.0**, every button method accepts an optional `options` parameter that allows you to customize the visual appearance of the button.

```ts
interface ButtonOptions {
    style?: "danger" | "primary" | "success";
    icon_custom_emoji_id?: string;
}
```

> \[!TIP]
> These properties are officially supported since Bot API 9.4.

* **style** — visual color style of the button. Can be `"danger"` (red), `"primary"` (blue), or `"success"` (green).
* **icon\_custom\_emoji\_id** — custom emoji identifier to be shown alongside the button text.

The `options` parameter is always the **last** argument of any button method:

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().text("Delete", { style: "danger" }).text("Confirm", {
    style: "success",
    icon_custom_emoji_id: "5368324170671202286",
});
```

It also works with static methods:

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
Keyboard.text("Cancel", { style: "danger" });
Keyboard.requestContact("Share contact", { style: "primary" });
```

![button styling preview](/keyboards/styling.png)

## Options ([Documentation](https://core.telegram.org/bots/api/#replykeyboardmarkup))

These parameters are responsible for the settings of the buttons

### resized

Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). If `false`, in which case the custom keyboard is always of the same height as the app's standard keyboard. Defaults to `true`.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().text("some text").resized(); // to enable
new Keyboard().text("some text").resized(false); // to disable
```

> \[!WARNING]
> The buttons are resized by default! To cancel this, use `.resized(false)`

### oneTime

Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to `false`.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().text("some text").oneTime(); // to enable
new Keyboard().text("some text").oneTime(false); // to disable
```

### persistent

Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to `false`, in which case the custom keyboard can be hidden and opened with a keyboard icon. Defaults to `false`.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().text("some text").persistent(); // to enable
new Keyboard().text("some text").persistent(false); // to disable
```

### selective

Use this parameter if you want to show the keyboard to specific users only.

Targets:

1. users that are @mentioned in the *text* of the [Message](https://core.telegram.org/bots/api/#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.

*Example:* A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard. Defaults to `false`.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().text("some text").selective(); // to enable
new Keyboard().text("some text").selective(false); // to disable
```

### placeholder

The placeholder to be shown in the input field when the keyboard is active. 1-64 characters. Defaults to `not to be`.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().text("some text").placeholder("some text"); // to enable
new Keyboard().text("some text").placeholder(); // to disable
```

## Helpers

Methods that help you build a keyboard.

### row

Adds a `line break`. Call this method to make sure that the next added buttons will be on a new row.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard().text("first row").row().text("second row");
```

### columns

Allows you to limit the number of columns in the keyboard.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard()
    .columns(1)
    .text("first row")
    .text("second row")
    .text("third row");
```

### wrap

A custom handler that controls row wrapping.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard()
    .wrap(({ button }) => button.text === "second row")
    .text("first row")
    .text("first row")
    .text("second row");
```

handler is

```ts
(options: { button: T; index: number; row: T[]; rowIndex: number }) => boolean;
```

### pattern

An array with the number of columns per row. Allows you to set a «template».

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard()
    .pattern([1, 3, 2])
    .text("1")
    .text("2")
    .text("2")
    .text("2")
    .text("3")
    .text("3");
```

### filter

A handler that helps filter keyboard buttons.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard()
    .filter(({ button }) => button.text !== "hidden")
    .text("pass")
    .text("hidden")
    .text("pass");
```

### add

Allows you to add multiple buttons in *raw* format.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
const labels = ["some", "buttons"];

new Keyboard()
    .add({ text: "raw button" })
    .add(Keyboard.text("raw button by Keyboard.text"))
    .add(...labels.map((x) => Keyboard.text(x)));
```

### addIf

Allows you to dynamically substitute buttons depending on something.

```ts twoslash
// @noErrors
import { Keyboard } from "@gramio/keyboards";
// ---cut---
const labels = ["some", "buttons"];
const isAdmin = true;

new Keyboard()
    .addIf(1 === 2, { text: "raw button" })
    .addIf(isAdmin, Keyboard.text("raw button by Keyboard.text"))
    .addIf(
        ({ index, rowIndex }) => rowIndex === index,
        ...labels.map((x) => Keyboard.text(x)),
    );
```

handler is

```ts
(options: { rowIndex: number; index: number }) => boolean;
```

### matrix

Allows you to create a button matrix.

```ts twoslash
// @noErrors
import { Keyboard } from "@gramio/keyboards";
// TODO: remove no errors
// ---cut---
import { randomInt } from "node:crypto";

const bomb = [randomInt(0, 9), randomInt(0, 9)] as const;

new Keyboard().matrix(10, 10, ({ rowIndex, index }) =>
    Keyboard.text(rowIndex === bomb[0] && index === bomb[1] ? "💣" : "ㅤ"),
);
```

The result is keyboard with a bomb on a random button

handler is

```ts
(options: { index: number; rowIndex: number }) => T;
```

### combine

Allows you to combine keyboards. Only keyboards are combined. You need to call the `.row()` method to line-break after combine.

```ts twoslash
import { Keyboard } from "@gramio/keyboards";
// ---cut---
new Keyboard()
    .combine(new Keyboard().text("first"))
    .row()
    .combine(new Keyboard().text("second").row().text("third"));
```

---

---
url: 'https://gramio.dev/plugins/official/scenes.md'
---

# @gramio/scenes

[![npm](https://img.shields.io/npm/v/@gramio/scenes?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/scenes)
[![JSR](https://jsr.io/badges/@gramio/scenes)](https://jsr.io/@gramio/scenes)
[![JSR Score](https://jsr.io/badges/@gramio/scenes/score)](https://jsr.io/@gramio/scenes)

The API can be changed a little, but we already use it in production environment.

# Usage

```ts twoslash
import { Bot } from "gramio";
import { scenes, Scene } from "@gramio/scenes";
import { z } from "zod";

export const greetingScene = new Scene("greeting")
    .params<{ test: boolean }>()
    .step("message", (context) => {
        if (context.scene.step.firstTime)
            return context.send("Hi! What's your name?");

        if (!context.text) return context.send("Please write your name");

        return context.scene.update({
            name: context.text,
        });
    })
    .ask(
        "age",
        z.coerce
            .number({
                required_error: "Please write your age correctly",
            })
            .min(18, "You must be at least 18 years old")
            .max(100, "You must be less than 100 years old"),
        "How old are you?"
    )
    .step("message", async (context) => {
        await context.send(
            `Nice to meet you! I now know that your name is ${
                context.scene.state.name
            } and you are ${context.scene.state.age} years old. ${
                //                           ^?
                context.scene.params.test ? "Also you have test param!" : ""
            }`
        );

        return context.scene.exit();
    });

const bot = new Bot(process.env.TOKEN as string)
    .extend(scenes([greetingScene]))
    .command("start", async (context) => {
        return context.scene.enter(greetingScene, {
            test: true,
        });
    });
```

### Share state between steps

```ts twoslash
import { Scene } from "@gramio/scenes";

const testScene = new Scene("test")
    .step("message", async (context) => {
        if (context.scene.step.firstTime || context.text !== "1")
            return context.send("1");

        return context.scene.update({
            messageId: context.id,
            some: "hii!" as const,
        });
    })
    .step("message", async (context) => {
        if (context.scene.step.firstTime || context.text !== "2")
            return context.send("2");

        console.log(context.scene.state.messageId);
        //                           ^?
    });
```

### step

This function defines a scene step. It is executed only when the current scene step id matches the registered step order.

```ts
const testScene = new Scene("test")
    // Handle single event type
    .step("message", async (context) => {
        if (context.scene.step.firstTime) return context.send("First message");
        return context.scene.exit();
    })
    // Handle multiple event types
    .step(["message", "callback_query"], async (context) => {
        if (context.scene.step.firstTime)
            return context.send("Follow-up message after user action");

        if (context.is("callback_query"))
            return context.answer("Inline button processed");

        return context.scene.exit();
    })
    // Universal handler
    .step((context) => {
        console.log(context);
        return context.scene.exit();
    });
```

### ask

> \[!WARNING]
> This API may change in future versions.

`ask` is a syntactic sugar over `step` that helps avoid boilerplate for simple validation steps.

Under the hood it uses [Standard Schema](https://standardschema.dev/), so you can use any validator that implements this standard (like [Zod](https://zod.dev/)).

First argument accepts the **key** where the value will be stored (types will be automatically inferred for next steps).
Second argument accepts **validation schema** that implements [Standard Schema](https://standardschema.dev/).
Third argument accepts the text that will be sent to user on **first step invocation** (`firstTime`).

An optional fourth argument accepts an options object with:

* **`onInvalidInput`** — custom handler called when validation fails, instead of auto-sending the schema's error message.

::: code-group

```ts [zod]
import { z } from "zod";

const testScene = new Scene("test")
    .ask(
        "email",
        z
            .string({
                required_error: "Please provide your email address",
            })
            .email("Invalid email format"),
        "Please enter your email"
    )
    .ask(
        "age",
        z.coerce
            .number({
                required_error: "Please enter valid age",
            })
            .min(18, "Minimum age is 18 years")
            .max(100, "Maximum age is 100 years"),
        "What is your age?"
    )
    .step("message", async (context) => {
        await context.send(
            `Registered email: ${context.scene.state.email}\nAge: ${context.scene.state.age}`
        );
        return context.scene.exit();
    });
```

```ts [sury]
import * as s from "sury";

const testScene = new Scene("test")
    .ask(
        "email",
        s.email(s.string, "Please provide your email address"),
        "Please enter your email"
    )
    .ask(
        "age",
        s.string.with(
            s.to, 
            s.max(
                s.min(
                    s.number,
                    18, 
                    "Minimum age is 18 years"
                ),
            100, 
            "Maximum age is 100 years"
        )),
        "What is your age?"
    )
    .step("message", async (context) => {
        await context.send(
            `Registered email: ${context.scene.state.email}\nAge: ${context.scene.state.age}`
        );
        return context.scene.exit();
    });
```

:::

**Custom error handling with `onInvalidInput`:**

```ts
const testScene = new Scene("test")
    .ask(
        "age",
        z.coerce.number().min(18, "You must be at least 18 years old"),
        "How old are you?",
        {
            onInvalidInput: async (context, error) => {
                await context.send(`❌ ${error.message}\nPlease try again.`);
            }
        }
    );
```

> \[!WARNING]
> Since we're working with text input, you should use [`z.coerce`](https://zod.dev/api?id=coercion) or similar validator methods that convert text to numbers for proper type handling.

## onEnter

Register a handler that runs once when a user enters the scene. Perfect for sending a welcome message or initializing data.

```ts
const registrationScene = new Scene("registration")
    .onEnter((context) => {
        return context.send("Welcome! Let's get you registered.");
    })
    .step("message", (context) => {
        if (context.scene.step.firstTime) return context.send("What's your name?");

        return context.scene.update({ name: context.text });
    });
```

The handler is async-compatible and will be awaited before proceeding to the first step.

## on

This method allows you to register event handlers for a scene.

```ts
const guessRandomNumberScene = new Scene("guess-random-number")
    .params<{ randomNumber: number }>()
    .on("message", async (context, next) => {
        // This check is needed so the handler does not trigger on firstTime because context will be the same as previous step
        if (context.scene.step.firstTime) return next();

        return await Promise.all([context.delete(), next()]);
    })
    .step(["message", "callback_query"], async (context) => {
        if (context.scene.step.firstTime)
            return context.send("Try to guess a number from 1 to 10");

        if (!context.is("message"))
            return context.answer("Please write a message with a number");

        const number = Number(context.text);

        if (
            Number.isNaN(number) ||
            number !== context.scene.params.randomNumber
        )
            return; // The handler above will delete the user's message

        return Promise.all([
            context.send(
                format(
                    `Congratulations! You guessed the number ${bold(
                        context.scene.params.randomNumber
                    )}!`
                )
            ),
            context.scene.exit(),
        ]);
    });
```

Keep in mind that a handler is registered only for all subsequent steps (or .on handlers) after it is declared.

```ts
new Scene("test")
    .on(...) // Called for all steps
    .step(...)
    .on(...) // Called only after the 2nd step is reached
    .step(...)
```

## Storage usage

```ts
import { redisStorage } from "@gramio/storage-redis";

const bot = new Bot(process.env.TOKEN as string)
    .extend(
        scenes([testScene], {
            storage: redisStorage(),
        })
    )
    .command("start", async (context) => {
        return context.scene.enter(someScene, {
            test: true,
        });
    });
```

[Read more about storages](/storages)

## Scene context

### update

`update` is a function that updates the data in the scene and preserves their types.

```ts twoslash
import { Scene } from "@gramio/scenes";

const testScene = new Scene("test")
    .step("message", async (context) => {
        if (context.scene.step.firstTime) return context.send("First message");

        if (!context.text) return context.delete();

        return context.scene.update({
            message: context.text,
        });
    })
    .step("message", async (context) => {
        return context.send(context.scene.state.message);
    });
```

### state

`state` is an object that contains all the data that has been "collected" in this scene.

(see the example above)

### params

`params` is an object that contains all the data that was passed to the scene on entry.

```ts twoslash
import { Bot } from "gramio";
import { scenes, Scene } from "@gramio/scenes";

const testScene = new Scene("test")
    // here we specify the type of scene parameters
    .params<{ test: boolean }>()
    .step("message", async (context) => {
        return context.send(context.scene.params.test);
    });

const bot = new Bot(process.env.TOKEN as string)
    .extend(scenes([testScene]))
    .command("start", async (context) => {
        return context.scene.enter(testScene, {
            test: true,
        });
    });
```

### reenter

`reenter` is a function that allows you to re-enter the scene at the first step, losing [state](#state).

```ts
const testScene = new Scene("test")
    .on("message", async (context, next) => {
        if (context.text === "/start") return context.scene.reenter();

        return next();
    })
    .step("message", async (context) => {
        if (context.scene.step.firstTime) return context.send("Hi!");

        return context.send("Bye!");
    });
```

### Step context

All information about the current scene step is stored in `context.scene.step`.

#### firstTime

`firstTime` is a flag that indicates whether the current step execution is the first.

```ts
const testScene = new Scene("test").step("message", async (context) => {
    if (context.scene.step.firstTime) return context.send("First message");

    if (context.text !== "next")
        return context.send("Subsequent messages until 'next' is written");

    return Promise.all([context.send("Last message"), context.scene.exit()]);
});
```

#### next

`next` is a function that passes control to the next scene step.

```ts
const testScene = new Scene("test").step("message", async (context) => {
    if (context.scene.step.firstTime) return context.send("First message");

    return context.scene.step.next();
});
```

#### previous

`previous` is a function that passes control to the previous scene step.

```ts
const testScene = new Scene("test").step("message", async (context) => {
    if (context.scene.step.firstTime) return context.send("First message");

    return context.scene.previous();
});
```

#### go

`go` is a function that passes control to a specific scene step.

```ts
const testScene = new Scene("test").step("message", async (context) => {
    if (context.scene.step.firstTime) return context.send("First message");

    return context.scene.go(5);
});
```

#### id

`id` is the identifier of the scene step.

```ts
const testScene = new Scene("test").step("message", async (context) => {
    if (context.scene.step.firstTime)
        return context.send(`Step ${context.scene.step.id}`);

    return context.scene.exit();
});
```

#### previousId

`previousId` is the identifier of the previous scene step.

The id of the last step is saved when calling [#go](#go), [#previous](#previous), [#next](#next).

```ts
const testScene = new Scene("test")
    .step("message", async (context) => {
        if (context.scene.step.firstTime)
            return context.send(
                `from step ${context.scene.step.previousId} to step ${context.scene.step.id}`
            );

        return context.scene.exit();
    })
    .step("message", async (context) => {
        return context.scene.step.go(1);
    });
```

## Scenes derives

Sometimes you want to control scenes before the plugin executes scene steps but after the scene is fetched from storage.

By default, the `scenes()` function derives what is needed for the next middlewares if the user is not in a scene.
With `scenesDerives()` you can get it earlier and manage scene data.

```ts twoslash
import { Scene } from "@gramio/scenes";

const testScene = new Scene("test").state<{
    simple: string;
    example: number[];
}>();
// ---cut---
import { scenes, scenesDerives, type AnyScene } from "@gramio/scenes";
import { Bot } from "gramio";
import { redisStorage } from "@gramio/storage-redis";

const storage = redisStorage();
const scenesList: AnyScene[] = [testScene];

const bot = new Bot(process.env.TOKEN as string)
    .extend(
        scenesDerives(scenesList, {
            withCurrentScene: true,
            storage,
        })
    )
    .on("message", (context, next) => {
        if (context.text === "/start" && context.scene.current) {
            if (context.scene.current.is(testScene)) {
                console.log(context.scene.current.state);
                //                                   ^?
                return context.scene.current.step.previous();
            } else return context.scene.current.reenter();
        }

        return next();
    })
    .extend(
        scenes(scenesList, {
            storage,
        })
    )
    .command("start", async (context) => {
        return context.scene.enter(testScene, {
            test: true,
        });
    });
```

> \[!IMPORTANT]
> The same **storage** and **list of scenes** should be shared across `scenes()` and `scenesDerives()` options.

By default, when registering the `scenes()` plugin, `inMemoryStorage` is used. So if you need to use `scenesDerives()` to manage scenes, you must declare `inMemoryStorage` yourself and explicitly specify it in both `scenesDerives()` and `scenes()` options.

```ts
import { inMemoryStorage } from "@gramio/storage";

const storage = inMemoryStorage(); // Stores in process memory and will be erased on restart

const bot = new Bot(process.env.TOKEN as string)
    .extend(scenes([testScene], { storage }))
    // ...
    .extend(scenesDerives([testScene], { storage }));
```

> \[!IMPORTANT]
> Be careful. The first step of the scene should also include the event from which you entered the scene. (For example, if you enter via InlineButton click — `callback_query`)

## Sharing context with plugins and composers

Use `scene.extend()` to bring plugin-derived types and enrichments into a scene's handler chain. This is the primary way to share data (database user, auth state, parsed arguments, etc.) across scene steps without passing it manually through `scene.state`.

### Extending with a Plugin

Any GramIO `Plugin` can be extended into a scene. The plugin's middleware — including `derive()`, `decorate()`, `guard()` — runs inside the scene chain and its types flow into step handlers:

```ts
import { Bot, Plugin } from "gramio";
import { Scene, scenes } from "@gramio/scenes";

// A shared plugin that loads the current user from the database
const withUser = new Plugin("withUser")
    .derive(async (ctx) => {
        const user = await db.users.findById(ctx.from!.id);
        return { user };
    });

const profileScene = new Scene("profile")
    .extend(withUser)  // ← ctx.user is now typed in every step
    .step("message", async (ctx) => {
        if (ctx.scene.step.firstTime)
            return ctx.send(`Hello, ${ctx.user.name}! What would you like to update?`);

        return ctx.scene.update({ newName: ctx.text });
    })
    .step("message", async (ctx) => {
        await db.users.update(ctx.from!.id, { name: ctx.scene.state.newName });
        await ctx.send(`Updated! Your new name: ${ctx.scene.state.newName}`);
        return ctx.scene.exit();
    });

const bot = new Bot(process.env.TOKEN!)
    .extend(withUser)
    .extend(scenes([profileScene]))
    .command("profile", (ctx) => ctx.scene.enter(profileScene));
```

> \[!TIP]
> If the same plugin is already extended at the **bot level**, the scene engine detects this and skips re-running its middleware inside the scene — avoiding double execution. The types are still available because they flow from the bot's main chain.

### Extending with an EventComposer

`scene.extend()` also accepts `EventComposer` instances — useful when you've built a reusable per-event enrichment that you want to share across multiple scenes:

```ts
import { Bot } from "gramio";
import { Scene, scenes } from "@gramio/scenes";

// A shared message enricher — parses command arguments
const withArgs = new Composer({ name: "withArgs" }).derive(["message"], (ctx) => ({
    args: ctx.text?.split(" ").slice(1) ?? [],
}));

const searchScene = new Scene("search")
    .extend(withArgs)  // ← ctx.args is typed in message steps
    .step("message", async (ctx) => {
        if (ctx.scene.step.firstTime)
            return ctx.send("What would you like to search for?");

        const query = ctx.args[0] ?? ctx.text ?? "";
        const results = await search(query);
        await ctx.send(`Found ${results.length} results`);
        return ctx.scene.exit();
    });
```

### Accessing shared context in `onEnter`

Extended plugin types are also available in `onEnter` handlers:

```ts
const checkoutScene = new Scene("checkout")
    .extend(withUser)
    .onEnter(async (ctx) => {
        // ctx.user is available here too
        if (ctx.user.balance < MIN_AMOUNT) {
            await ctx.send("Insufficient balance.");
            return ctx.scene.exit();
        }
        return ctx.send(`Starting checkout for ${ctx.user.name}...`);
    })
    .step("message", async (ctx) => {
        // ... checkout steps
    });
```

## VS Prompt

> Spoiler: We recommend using `scenes`

`prompt` and `scenes` are two plugins for the same purpose: asking and receiving answers from users.

`prompt` is a simpler version implemented using `Promise` and `in-memory` storage. It's easier for simple Question-Answer scenarios but has limitations like data being stored in process memory and lost on restart.

`scenes` solves this with its step-based approach and supports any storage like `Redis`, making it reliable for production use.

---

---
url: 'https://gramio.dev/files/overview.md'
---

# Overview

[`@gramio/files`](https://github.com/gramiojs/files) is built-in GramIO package. You can also use it outside of this framework because it is framework-agnostic.

## Usage

```ts twoslash
// @errors: 2345
import { Bot, MediaInput, MediaUpload, InlineKeyboard } from "gramio";

const bot = new Bot(process.env.BOT_BOT_TOKEN as string)
    .on("message", async (ctx) => {
        ctx.sendMediaGroup([
            MediaInput.document(
                await MediaUpload.url(
                    "https://raw.githubusercontent.com/gramiojs/types/main/README.md"
                )
            ),
            MediaInput.document(await MediaUpload.path("./package.json")),
        ]);
    })
    .onStart(console.log);

bot.start();
```

## Sending files

There are three ways to send files (photos, stickers, audio, media, etc.):

1. If the file is already stored somewhere on the Telegram servers, you don't need to reupload it: each file object has a file\_id field, simply pass this file\_id as a parameter instead of uploading. There are no limits for files sent this way.

> \[!TIP]
> You may find it useful to use the [media-cache](/ru/plugins/official/media-cache) plugin to cache `file_id` on the framework side.

2. Provide Telegram with an HTTP URL for the file to be sent. Telegram will download and send the file. 5 MB max size for photos and 20 MB max for other types of content.
3. Post the file using multipart/form-data in the usual way that files are uploaded via the browser. 10 MB max size for photos, 50 MB for other files.

### Sending by `file_id`

* It is not possible to change the file type when resending by file\_id. I.e. a video can't be sent as a photo, a photo can't be sent as a document, etc.
* It is not possible to resend thumbnails.
* Resending a photo by file\_id will send all of its sizes.
* file\_id is unique for each individual bot and can't be transferred from one bot to another.
* file\_id uniquely identifies a file, but a file can have different valid file\_ids even for the same bot.

To send a file by `file_id` with GramIO, you can put it `as is`.

```ts twoslash
import { BotLike, MessageContext } from "gramio";

const fileId = "" as string;
const ctx = {} as InstanceType<MessageContext<BotLike>>;

// ---cut---
ctx.sendPhoto(fileId);
```

### Sending by `URL`

* When sending by URL the target file must have the correct MIME type (e.g., audio/mpeg for sendAudio, etc.).
* In sendDocument, sending by URL will currently only work for GIF, PDF and ZIP files.
* To use sendVoice, the file must have the type audio/ogg and be no more than 1MB in size. 1-20MB voice notes will be sent as files.

To send a file by `URL` with GramIO, you can put it `as is`.

```ts twoslash
import { BotLike, MessageContext } from "gramio";

const ctx = {} as InstanceType<MessageContext<BotLike>>;

// ---cut---
ctx.sendPhoto("https://.../cute-cat.png");
```

### File uploading

To upload and send file you can use [`Media Upload`](/files/media-upload.html) Class-helper and GramIO will do all the work for you.

```ts twoslash
// @errors: 2345
import { MediaUpload } from "@gramio/files";
import { BotLike, MessageContext } from "gramio";

const ctx = {} as InstanceType<MessageContext<BotLike>>;
// ---cut---
ctx.sendPhoto(await MediaUpload.path("../cute-cat.png"));
```

#### Use [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File)

In fact, GramIO can accept Web API's [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) and [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob).

So you can upload files even like this:

```ts
import { Elysia } from "elysia";
import { bot } from "./bot";

new Elysia().post(
    "/",
    ({ body: { file } }) => {
        bot.api.sendPhoto({
            chat_id: 1,
            photo: file,
        });
    },
    {
        body: t.Object({
            file: t.File({
                type: "image",
                maxSize: "2m",
            }), // Elysia validates and accepts only the File type
        }),
    }
);
```

Or, for example, with [Bun native File reader](https://bun.sh/docs/api/file-io#reading-files-bun-file)

```ts
bot.api.sendDocument({
    chat_id: 1,
    document: Bun.file("README.md"),
});
```

---

---
url: 'https://gramio.dev/plugins/official/sentry.md'
---
# Sentry

[![npm](https://img.shields.io/npm/v/@gramio/sentry?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/sentry)
[![JSR](https://jsr.io/badges/@gramio/sentry)](https://jsr.io/@gramio/sentry)
[![JSR Score](https://jsr.io/badges/@gramio/sentry/score)](https://jsr.io/@gramio/sentry)

Sentry error tracking for GramIO with automatic error capture, user identification, breadcrumbs, and optional tracing. Uses `@sentry/core` for runtime-agnostic support (Bun + Node.js).

### Installation

::: pm-add @gramio/sentry
:::

### Usage

```typescript
import { Bot } from "gramio";
import { sentryPlugin } from "@gramio/sentry";

const bot = new Bot(process.env.BOT_TOKEN!)
    .extend(sentryPlugin({
        setUser: true,
        breadcrumbs: true,
        tracing: false,
    }))
    .command("test", (context) => {
        context.sentry.captureMessage("Something happened");
        context.sentry.setTag("custom", "value");
    });

await bot.start();
```

### Options

| Option | Type | Description |
|--------|------|-------------|
| `setUser` | `boolean` | Automatically set the Sentry user from `context.from` |
| `breadcrumbs` | `boolean` | Add a breadcrumb for each update and API call |
| `tracing` | `boolean` | Enable per-update isolation scopes and spans |

## Methods

All methods are available on `context.sentry`:

### `captureMessage(msg)`

Sends a message event to Sentry:

```typescript
context.sentry.captureMessage("User reached step 3");
```

### `captureException(error)`

Captures an exception and sends it to Sentry:

```typescript
try {
    await riskyOperation();
} catch (error) {
    context.sentry.captureException(error);
}
```

### `setTag(key, value)`

Sets a tag on the current Sentry scope:

```typescript
context.sentry.setTag("feature", "onboarding");
```

### `setExtra(key, value)`

Attaches extra data to the current Sentry scope:

```typescript
context.sentry.setExtra("payload", context.message);
```

---

---
url: 'https://gramio.dev/plugins/official/session.md'
---

# Session Plugin

[![npm](https://img.shields.io/npm/v/@gramio/session?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/session)
[![JSR](https://jsr.io/badges/@gramio/session)](https://jsr.io/@gramio/session)
[![JSR Score](https://jsr.io/badges/@gramio/session/score)](https://jsr.io/@gramio/session)

Session plugin for GramIO.

### Installation

::: pm-add @gramio/session
:::

## Usage

```ts twoslash
import { Bot } from "gramio";
import { session } from "@gramio/session";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(
        session({
            key: "sessionKey",
            initial: () => ({ apple: 1 }),
        })
    )
    .on("message", (context) => {
        context.send(`apple count is ${++context.sessionKey.apple}`);
        //                                        ^?
    })
    .onStart(console.log);

bot.start();
```

You can use this plugin with any storage ([Read more](/storages))

### Redis example

[More info](https://github.com/gramiojs/storages/tree/master/packages/redis)

```ts
import { Bot } from "gramio";
import { session } from "@gramio/session";
import { redisStorage } from "@gramio/storage-redis";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(
        session({
            key: "sessionKey",
            initial: () => ({ apple: 1 }),
            storage: redisStorage(),
        })
    )
    .on("message", (context) => {
        context.send(`apple count is ${++context.sessionKey.apple}`);
    })
    .onStart(console.log);

bot.start();
```

## Lazy Sessions

By default the session is loaded from storage on every update, even if the handler never reads it. Enabling `lazy: true` defers the load until the session is actually accessed, which can significantly reduce unnecessary storage reads on high-traffic bots.

```ts
import { Bot } from "gramio";
import { session } from "@gramio/session";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(
        session({
            key: "sessionKey",
            lazy: true,
            initial: () => ({ count: 0 }),
        })
    )
    .on("message", async (context) => {
        // Storage is not read until here:
        const s = await context.sessionKey;
        s.count++;
        await context.send(`count: ${s.count}`);
    });
```

In lazy mode `context.sessionKey` is a `Promise` — always `await` it before accessing data.

## Session Clearing

Call `$clear()` on the session object to delete it from storage and reset to the initial state on the next access.

```ts
bot.on("message", async (context) => {
    if (context.text === "/reset") {
        await context.sessionKey.$clear();
    }
});
```

In lazy mode, resolve the promise first:

```ts
bot.on("message", async (context) => {
    if (context.text === "/reset") {
        const s = await context.sessionKey;
        await s.$clear();
    }
});
```

## Custom Session Keys

Sessions are keyed by `senderId` by default. Use `getSessionKey` to change the scoping strategy.

```ts
// Per-chat session
session({
    getSessionKey: (ctx) => `chat:${ctx.chatId}`,
    initial: () => ({ topic: "" }),
})

// Per-user-per-chat session
session({
    getSessionKey: (ctx) => `${ctx.senderId}:${ctx.chatId}`,
    initial: () => ({ preferences: {} }),
})
```

## TypeScript

Session data is automatically typed from the `initial` return type. You can also pass an explicit interface.

```ts
interface MySessionData {
    apple: number;
    some?: "maybe-empty";
}

// Eager mode — ctx.sessionKey: MySessionData & { $clear(): Promise<void> }
bot.extend(
    session({
        key: "sessionKey",
        initial: (): MySessionData => ({ apple: 1 }),
    })
);

// Lazy mode — ctx.sessionKey: Promise<MySessionData & { $clear(): Promise<void> }>
bot.extend(
    session({
        key: "sessionKey",
        lazy: true,
        initial: (): MySessionData => ({ apple: 1 }),
    })
);
```

---

---
url: 'https://gramio.dev/awesome.md'
---
# Something about GramIO

### Bots

* ...
* Your bot

---

---
url: 'https://gramio.dev/plugins/official/split.md'
---

# Split

[![npm](https://img.shields.io/npm/v/@gramio/split?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/split)
[![npm downloads](https://img.shields.io/npm/dw/@gramio/split?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/split)
[![JSR](https://jsr.io/badges/@gramio/split)](https://jsr.io/@gramio/split)
[![JSR Score](https://jsr.io/badges/@gramio/split/score)](https://jsr.io/@gramio/split)

This package splits messages that exceed the Telegram character limit into multiple parts. It also **correctly splits Telegram message entities** (bold, italic, links, etc.) across boundaries, so formatting is preserved in each part without manual offset recalculation.

## Installation

::: pm-add @gramio/split
:::

## Usage

```ts
import { Bot, format, bold } from "gramio";
import { splitMessage } from "@gramio/split";

const bot = new Bot(process.env.BOT_TOKEN!)
    .command("start", async (context) => {
        const messages = await splitMessage(
            format`${bold("a".repeat(4096 * 2))}`,
            (str) => context.send(str)
        );

        console.log(messages); // array of send results
    });

await bot.start();
```

> \[!WARNING]
> If you want to pass `context.send` without a function wrapper, use `context.send.bind(context)` — otherwise it will lose context data.

### Usage with other frameworks

`@gramio/split` can be used independently of GramIO — the `action` callback receives a `FormattableString` with `.text` and `.entities` properties:

```ts
import { splitMessage } from "@gramio/split";
import { format, bold } from "@gramio/format";

const messages = await splitMessage(
    format`${bold("a".repeat(4096 * 2))}`,
    ({ text, entities }) => {
        return someOtherFramework.sendMessage(text, { entities });
    }
);
```

## API

### splitMessage

```ts
function splitMessage<ReturnData>(
    text: FormattableString | string,
    action: (formattableString: FormattableString) => MaybePromise<ReturnData>,
    limit?: number
): Promise<ReturnData[]>
```

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `text` | `FormattableString \| string` | — | The message text to split. Can be a plain string or a `FormattableString` from `@gramio/format` (which carries entities). |
| `action` | `(formattableString: FormattableString) => MaybePromise<ReturnData>` | — | A callback invoked **sequentially** for each split part. The return value is collected into the result array. |
| `limit` | `number` | `4096` | Maximum character length per part. |

**Returns:** `Promise<ReturnData[]>` — an array of results from each `action` call, in order.

The `action` callback is called sequentially (not in parallel), which preserves correct message ordering in Telegram.

## Custom limit

The default limit is **4096** characters (`sendMessage`). For photo/video captions use **1024**:

```ts
import { splitMessage } from "@gramio/split";
import { format, bold } from "@gramio/format";

const messages = await splitMessage(
    format`${bold("a".repeat(4096))}`,
    ({ text, entities }) => {
        return context.sendPhoto(PHOTO, {
            caption: text,
            caption_entities: entities,
        });
    },
    1024
);
```

## How entity splitting works

When a message is split, entities are handled as follows:

* Entities that fit **entirely within** the current part are kept as-is.
* Entities that **span the split boundary** are split: the first part gets the entity truncated to the boundary, and the remaining part gets a new entity with recalculated `offset` and `length`.
* Entities **entirely in the remaining text** get their `offset` shifted accordingly.

This means formatting like **bold**, *italic*, [links](https://example.com), `code`, and other Telegram entities are always preserved correctly across all parts.

---

---
url: 'https://gramio.dev/storages.md'
---

# Storages

These are some kind of data stores. Their main use is in plugins (for example, [sessions](/plugins/official/session)).

## Adapters

GramIO has many ready-made adapters, but you can also write your own!

* [In Memory](#in-memory) (`@gramio/storage`)

* [Redis](#redis) (`@gramio/storage-redis`)

* [SQLite](#sqlite) (`@gramio/storage-sqlite`)

* [Cloudflare KV](#cloudflare-kv) (`@gramio/storage-cloudflare`)

## How to write my own storage adapters

It is very simple to write your adapter!

It is enough to return the object with the required methods and use the methods of the solution you have chosen for the adapter. (for example, `ioredis`)

```ts
import type { Storage } from "@gramio/storage";
import ThirdPartyStorage, { type ThirdPartyStorageOptions } from "some-library";

export interface MyOwnStorageOptions extends ThirdPartyStorageOptions {
    /** add new property to options */
    some?: number;
}

export function myOwnStorage(options: MyOwnStorageOptions = {}): Storage {
    const storage = new ThirdPartyStorage(options);

    return {
        async get(key) {
            const data = await storage.get(key);

            return data ? JSON.parse(data) : undefined;
        },
        async has(key) {
            return storage.has(key);
        },
        async set(key, value) {
            await storage.set(key, JSON.stringify(value));
        },
        async delete(key) {
            return storage.delete(key);
        },
    };
}
```

> \[!IMPORTANT]
> If you want to publish your adapter, we recommend that you follow the **convention** and name it starting with `gramio-storage` and add `gramio` + `gramio-storage` keywords in your **package.json**

## How to use storage adapters in my own plugin

It is also very easy to work with storage adapters in your plugin!

Everything we need is already in `@gramio/storage`.

```ts
import { Plugin } from "gramio";
import { type Storage, inMemoryStorage } from "@gramio/storage";

export interface MyOwnPluginOptions {
    storage?: Storage;
}

export function myOwnPlugin(options: MyOwnPluginOptions = {}) {
    // use in memory storage by default
    const storage = options.storage ?? inMemoryStorage();

    return new Plugin("gramio-example");
}
```

> \[!IMPORTANT]
> You can scaffold this example by [create-gramio-plugin](/plugins/how-to-write.html#scaffolding-the-plugin)

## Type-safe storage with generics

All storage adapters support a generic type parameter `Storage<Data>` that provides type safety for keys and values. This enables TypeScript to infer the correct value type based on the key you're accessing.

### Basic usage

```ts twoslash
import { inMemoryStorage } from "@gramio/storage";

interface UserData {
    username: string;
    email: string;
    age: number;
}

const storage = inMemoryStorage<UserData>();

await storage.set("username", "john_doe");
await storage.set("email", "john@example.com");

const username = await storage.get("username"); // string | undefined
//      ^?
```

### Template literal types

`Storage<Data>` works seamlessly with TypeScript's template literal types, allowing you to define dynamic key patterns:

```ts twoslash
import { inMemoryStorage } from "@gramio/storage";

type Data = Record<`user:${number}`, { name: string; age: number }> &
    Record<`session:${string}`, { token: string; expires: number }>;

const storage = inMemoryStorage<Data>();

await storage.set("user:1", { name: "Alice", age: 30 });
await storage.set("session:abc123", { token: "xyz", expires: 1234567890 });

const user = await storage.get("user:1");
//     ^?

const session = await storage.get("session:abc123");
//     ^?
```

### Complex type unions

You can combine multiple record types for different key patterns:

```ts twoslash
import { inMemoryStorage } from "@gramio/storage";

type StorageSchema = Record<`counter:${string}`, number> &
    Record<`flag:${string}`, boolean> &
    Record<`data:${string}`, { value: string; timestamp: number }>;

const storage = inMemoryStorage<StorageSchema>();

await storage.set("counter:views", 42);
await storage.set("flag:enabled", true);
await storage.set("data:config", { value: "test", timestamp: Date.now() });

const views = await storage.get("counter:views"); // number | undefined
//     ^?
```

This type safety works across all storage adapters (in-memory, Redis, Cloudflare KV, etc.) and helps prevent runtime errors by catching type mismatches at compile time.

## Adapter versions

| Adapter | Latest version |
|---------|---------------|
| `@gramio/storage` (In Memory) | **2.0.1** |
| `@gramio/storage-redis` | **1.0.5** |
| `@gramio/storage-cloudflare` | **0.0.2** |
| `@gramio/storage-sqlite` | **0.0.2** |

The `Storage` interface in v2.0.x uses a generic `Data` type with typed keys across all methods (`get`, `set`, `has`, `delete`). All adapters serialize keys via `String()` for backward compatibility. This is the foundation for the type-safe storage generics described above.

## List

## In Memory

[![npm](https://img.shields.io/npm/v/@gramio/storage?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/storage)
[![npm downloads](https://img.shields.io/npm/dw/@gramio/storage?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/storage)
[![JSR](https://jsr.io/badges/@gramio/storage)](https://jsr.io/@gramio/storage)
[![JSR Score](https://jsr.io/badges/@gramio/storage/score)](https://jsr.io/@gramio/storage)

##### Installation

::: pm-add @gramio/storage
:::

##### Usage

1. With default [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)

```ts twoslash
import { inMemoryStorage } from "@gramio/storage";

const storage = inMemoryStorage();
```

2. Provide your own [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)

```ts twoslash
import { inMemoryStorage, type InMemoryStorageMap } from "@gramio/storage";

const map: InMemoryStorageMap = new Map();

const storage = inMemoryStorage(map);
```

## Redis

[![npm](https://img.shields.io/npm/v/@gramio/storage-redis?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/storage-redis)
[![npm downloads](https://img.shields.io/npm/dw/@gramio/storage-redis?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/storage-redis)
[![JSR](https://jsr.io/badges/@gramio/storage-redis)](https://jsr.io/@gramio/storage-redis)
[![JSR Score](https://jsr.io/badges/@gramio/storage-redis/score)](https://jsr.io/@gramio/storage-redis)

##### Installation

::: pm-add @gramio/storage-redis ioredis
:::

##### Usage

1. Provide ioredis options to the `redisStorage` function

```ts twoslash
import { redisStorage } from "@gramio/storage-redis";

const storage = redisStorage({
    host: process.env.REDIS_HOST,
});
```

2. Provide ioredis instance to the `redisStorage` function

```ts twoslash
import { redisStorage } from "@gramio/storage-redis";
import { Redis } from "ioredis";

const redis = new Redis({
    host: process.env.REDIS_HOST,
});

const storage = redisStorage(redis);
```

##### Tips

* You can set the `DEBUG` env to `ioredis:*` to print debug info:

```bash
DEBUG=ioredis:* npm run start
```

and it will looks like this:

```bash
  ioredis:redis write command[::1:6379]: 0 -> get([ '@gramio/scenes:617580375' ]) +187ms
  ioredis:redis write command[::1:6379]: 0 -> set([ '@gramio/scenes:617580375', '{"name":"scene-name","state":{},"stepId":0,"previousStepId":0,"firstTime":false}' ]) +1ms
```

* For inspecting which data is stored in Redis, we recommend you to use GUI clients like [AnotherRedisDesktopManager](https://github.com/qishibo/AnotherRedisDesktopManager).

## SQLite

[![npm](https://img.shields.io/npm/v/@gramio/storage-sqlite?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/storage-sqlite)
[![npm downloads](https://img.shields.io/npm/dw/@gramio/storage-sqlite?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/storage-sqlite)

> \[!TIP]
> Supports both **Bun** (`bun:sqlite`) and **Node.js** (`node:sqlite`). The correct implementation is auto-selected based on your runtime.

##### Installation

```bash [bun]
bun install @gramio/storage-sqlite
```

##### Usage

1. Pass a filename to create a new database

```ts
import { sqliteStorage } from "@gramio/storage-sqlite";

const storage = sqliteStorage({ filename: "bot-data.db" });
```

2. Pass an existing Bun SQLite Database instance

```ts
import { sqliteStorage } from "@gramio/storage-sqlite";
import { Database } from "bun:sqlite";

const db = new Database("bot-data.db");
const storage = sqliteStorage({ db });
```

3. With TTL (automatic key expiry)

```ts
import { sqliteStorage } from "@gramio/storage-sqlite";

const storage = sqliteStorage({
    filename: "bot-data.db",
    $ttl: 3600, // keys expire after 1 hour
});
```

##### Options

* `filename` — Path to the SQLite file
* `db` — Alternatively, pass a pre-existing `Database` instance
* `$ttl` — Optional TTL in seconds for automatic expiry
* `tableName` — Custom table name (defaults to `"gramio_storage"`)

## [Cloudflare KV](https://developers.cloudflare.com/kv/)

[![npm](https://img.shields.io/npm/v/@gramio/storage-cloudflare?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/storage-cloudflare)
[![npm downloads](https://img.shields.io/npm/dw/@gramio/storage-cloudflare?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/storage-cloudflare)
[![JSR](https://jsr.io/badges/@gramio/storage-cloudflare)](https://jsr.io/@gramio/storage-cloudflare)
[![JSR Score](https://jsr.io/badges/@gramio/storage-cloudflare/score)](https://jsr.io/@gramio/storage-cloudflare)

##### Installation

::: pm-add @gramio/storage-cloudflare
:::

##### Usage

1. [Configure Cloudflare KV namespace](https://developers.cloudflare.com/kv/get-started/)

2. Provide Cloudflare KV namespace to the `cloudflareStorage` function

```ts
import { cloudflareStorage } from "@gramio/storage-cloudflare";

const storage = cloudflareStorage(Env.CLOUDFLARE_KV_NAMESPACE);
```

---

---
url: 'https://gramio.dev/changelogs/2026-02-08.md'
---

# Storage Gets Type-Safe Keys, Scenes Learn `onEnter` & SQLite Joins the Family

**January 1 – February 8, 2026**

The headline of this cycle: `@gramio/storage` ships a **major v2.0.0** with typed template literal keys, a brand-new **SQLite adapter** lands for Bun, and scenes get a long-awaited `onEnter()` hook. Plus: callback queries now expose `chatId` directly, and `UniqueGiftInfo` adapts to Telegram's new TON payment fields. Here's everything that shipped.

## @gramio/storage v2.0.0 — Typed Keys with Template Literals

### BREAKING: Storage interface now uses `keyof Data` for all keys

This is the biggest change of the cycle. The `Storage<Data>` interface has been completely reworked — all four methods (`get`, `set`, `has`, `delete`) now constrain keys to `keyof Data` and infer value types from the key automatically.

**Before (v1.x):**

```ts
interface Storage<Data = any> {
    get<T = Data>(key: string): MaybePromise<Data | undefined>;
    set(key: string, value: Data): MaybePromise<void>;
    // ...
}
```

**After (v2.0.0):**

```ts
interface Storage<Data = any> {
    get<K extends keyof Data>(key: K): MaybePromise<Data[K] | undefined>;
    set<K extends keyof Data>(key: K, value: Data[K]): MaybePromise<void>;
    has<K extends keyof Data>(key: K): MaybePromise<boolean>;
    delete<K extends keyof Data>(key: K): MaybePromise<boolean>;
}
```

This means TypeScript now **infers the correct value type** based on the key you're accessing — including template literal patterns:

```ts
type Data = Record<`user:${number}`, { name: string; age: number }>
    & Record<`session:${string}`, { token: string; expires: number }>;

const storage = inMemoryStorage<Data>();

await storage.set("user:1", { name: "Alice", age: 30 });
const user = await storage.get("user:1");
//    ^? { name: string; age: number } | undefined

await storage.set("session:abc", { token: "xyz", expires: 123 });
const session = await storage.get("session:abc");
//    ^? { token: string; expires: number } | undefined
```

**Migration:** If you were using `storage.get<SomeType>("key")` to override the return type, this pattern no longer works. Instead, define your key-value mapping as a type parameter to the storage constructor.

### Bug fix: `inMemoryStorage` generic types now flow correctly

The `inMemoryStorage<Data>()` function now properly passes its generic through to the `Storage<Data>` interface, fixing implicit `any` issues in previous versions.

## @gramio/storage-sqlite — New SQLite Adapter (Bun)

A brand-new storage adapter backed by SQLite has landed! It uses `bun:sqlite` under the hood with WAL journal mode for maximum performance.

```ts
import { sqliteStorage } from "@gramio/storage-sqlite";

// Pass a filename — creates a new database automatically
const storage = sqliteStorage({ filename: "bot-data.db" });

// Or pass an existing Bun SQLite Database instance
import { Database } from "bun:sqlite";
const db = new Database("bot-data.db");
const storage = sqliteStorage({ db });
```

**Features:**

* **TTL support** — Set `$ttl` in seconds for automatic key expiry
* **Custom table name** — Defaults to `"gramio_storage"`, configurable via `tableName`
* **JSONB storage** — Values are JSON-serialized and stored as JSONB
* **Lazy expiry** — Expired entries are cleaned on startup and checked on each `get()`

> \[!WARNING]
> This adapter currently supports **Bun only**. Node.js support is planned — PRs are welcome!

## @gramio/storage-redis — ioredis Moved to Peer Dependencies

`ioredis` is no longer bundled as a direct dependency of `@gramio/storage-redis`. You now need to install it separately:

::: pm-add @gramio/storage-redis ioredis
:::

This gives you full control over the `ioredis` version and avoids duplication when you're already using it elsewhere in your project.

## @gramio/scenes — `onEnter()` Hook

### Run logic when a user enters a scene

Scenes now support an `onEnter()` method that lets you register a handler to run once when a scene is entered — perfect for sending a welcome message, initializing state, or logging.

```ts
import { Scene } from "@gramio/scenes";

const registrationScene = new Scene("registration")
    .onEnter((context) => {
        return context.send("Welcome to the registration wizard! Let's get started.");
    })
    .step("message", (context) => {
        if (context.scene.step.firstTime) return context.send("What's your name?");
        // ...
    });
```

The handler is fully async-compatible and is awaited before the scene proceeds. Community contribution by [@unitoshka](https://github.com/fdmafhgs).

## @gramio/contexts v0.3.1 — Callback Query `chatId` & UniqueGift TON Support

### `chatId` on callback query context

You no longer need to dig through `context.message?.chat?.id` to get the chat ID in a callback query handler. The new `chatId` getter gives you direct access:

```ts
bot.on("callback_query", (context) => {
    console.log(context.chatId); // number | undefined
});
```

Community contribution by [@n08i40k](https://github.com/n08i40k).

### UniqueGiftInfo adapts to Telegram's new resale fields

Telegram updated the Bot API to support **TON (toncoin)** payments for unique gift resales. `UniqueGiftInfo` has been updated with two new properties:

* **`lastResaleCurrency`** — `"XTR"` (Telegram Stars) or `"TON"` (toncoins)
* **`lastResaleAmount`** — The raw payment amount in the respective currency

The existing `lastResaleStarCount` now returns the amount only when `lastResaleCurrency === "XTR"`, and `undefined` otherwise. The `@gramio/types` dependency was bumped to `^9.3.0` to match.

## Documentation & Community

### Type-safe storage docs with generics

A whole new section was added to the [Storages](/storages) page covering type-safe storage with generics — basic usage, template literal types, and complex type unions. Both EN and RU versions.

### Community contributions

* **Sury validation examples** added to scenes `.ask()` docs alongside existing Zod examples ([@unitoshka](https://github.com/fdmafhgs))
* **Fixed** `context.scene.next()` → `context.scene.step.next()` in scenes docs
* **Fixed** undefined language errors in code blocks (`curl` → `bash`, `tree` → `bash`)
* **Fixed** broken autoload plugin link pointing to wrong URL ([@ttempaa](https://github.com/ttempaa))
* **Renamed** `index.md` → `overview.md` for plugins, storages, and TMA to fix VitePress routing ([@ttempaa](https://github.com/ttempaa))
* **Added** `AGENTS.md` with bilingual documentation sync rules

### Examples: Forum bot migrates to Cloudflare Workers

The `gramio-forum-bot` example was fully migrated to Cloudflare Workers with proper HMAC webhook verification via Web Crypto API, token sanitization, message truncation (4096 char limit), and noise filtering for `chore(deps)` commits. New webhook handlers were added for `issue_comment`, `pull_request_review`, and `pull_request_review_comment` events.

---

---
url: 'https://gramio.dev/api/storage-redis/ioredis.md'
---
[GramIO API Reference](../../../../index.md) / storage-redis/ioredis

# storage-redis/ioredis

## Interfaces

| Interface | Description |
| ------ | ------ |
| [RedisStorageOptions](interfaces/RedisStorageOptions.md) | - |

## Functions

### redisStorage()

> **redisStorage**(`optionsRaw?`): [`Storage`](../../../storage/dist/interfaces/Storage.md)

Defined in: storage-redis/ioredis.d.ts:8

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `optionsRaw?` | [`RedisStorageOptions`](interfaces/RedisStorageOptions.md) | `Redis` |

#### Returns

[`Storage`](../../../storage/dist/interfaces/Storage.md)

---

---
url: 'https://gramio.dev/guides/composer.md'
---

# Structuring Large Bots with Composer

When a bot grows beyond a single file, the chain in `bot.ts` becomes hard to read. GramIO's answer is `Composer` — the same building block `Bot` is built on. You can extract any part of the chain into a `Composer`, type it independently, and merge it back with `.extend()`.

::: tip Reference
This guide focuses on practical patterns. For the complete API surface — `when()`, `inspect()`, `trace()`, scope system — see the [Middleware & Context](/extend/middleware) reference.
:::

***

## The Problem

A bot with many features ends up looking like this:

```ts
const bot = new Bot(token)
    .derive(fetchUser)
    .derive(fetchChat)
    .command("start", ...)
    .command("help", ...)
    .command("ban", ...)
    .command("kick", ...)
    .command("stats", ...)
    .on("message", ...)
    .callbackQuery("confirm", ...)
    .callbackQuery("cancel", ...)
    // ... 50 more handlers
    .start();
```

`Composer` lets you split this into focused modules that each own their handlers and context enrichment.

***

## What is a Composer?

`Composer` is the class that powers `Bot` itself. Everything you can chain on a `Bot` — `.command()`, `.on()`, `.derive()`, `.guard()`, `.extend()` — works identically on a `Composer`.

The difference: a `Composer` isn't a bot. It has no token, no API connection. It's a pipeline segment you compose into a bot with `.extend()`.

```ts
import { Composer } from "gramio";

// A self-contained feature module
const adminRouter = new Composer()
    .guard((ctx) => ctx.from?.id === ADMIN_ID)
    .command("ban",   (ctx) => ctx.send("Banned!"))
    .command("stats", (ctx) => ctx.send("Stats..."));

// Merged into the bot at this point in the chain
const bot = new Bot(token)
    .extend(adminRouter)
    .start();
```

***

## Splitting into Files

The most common use: one file per feature.

```ts
// src/features/start.ts
import { Composer } from "gramio";

export const startRouter = new Composer()
    .command("start", (ctx) => ctx.send("Hello! 👋"))
    .command("help",  (ctx) => ctx.send("Commands: /start /help"));
```

```ts
// src/features/admin.ts
import { Composer } from "gramio";

const ADMIN_ID = Number(process.env.ADMIN_ID);

export const adminRouter = new Composer()
    .guard((ctx) => ctx.from?.id === ADMIN_ID, (ctx) => ctx.send("Admins only."))
    .command("broadcast", (ctx) => ctx.send("Broadcasting..."))
    .command("stats",     (ctx) => ctx.send("Stats..."));
```

```ts
// src/bot.ts
import { Bot } from "gramio";
import { startRouter } from "./features/start";
import { adminRouter } from "./features/admin";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(startRouter)
    .extend(adminRouter)
    .start();
```

Clean, readable, each feature isolated.

***

## Sharing Context Across Modules

Often multiple modules need the same data — a user record, config, a database connection. Extract it into shared middleware:

```ts
// src/middleware/user.ts
import { Composer } from "gramio";

export const withUser = new Composer()
    .derive(async (ctx) => ({
        user: await db.getUser(ctx.from?.id ?? 0),
    }))
    .as("scoped"); // writes ctx.user to the real ctx, not a local copy
```

Extend it in your feature module to get the type:

```ts
// src/features/profile.ts
import { Composer } from "gramio";
import { withUser } from "../middleware/user";

export const profileRouter = new Composer()
    .extend(withUser)  // ctx.user is now typed
    .command("profile", (ctx) =>
        ctx.send(`Name: ${ctx.user.name}`)
        //              ^? { name: string, ... }
    );
```

Then in `bot.ts`, extend `withUser` **before** the routers so the derive runs on the real context:

```ts
import { Bot } from "gramio";
import { withUser } from "./middleware/user";
import { profileRouter } from "./features/profile";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(withUser)      // ← first: ctx.user lands on the real ctx
    .extend(profileRouter) // ← withUser inside is deduplicated (skipped)
    .start();
```

::: info Why `.as("scoped")`?
By default, `.extend()` isolates the inner context so its derives don't leak out. `.as("scoped")` opts out of isolation — the derive writes directly to the parent context, so downstream code can read `ctx.user` from anywhere in the chain.

See [Middleware & Context → Scope System](/extend/middleware#production-architecture) for the full picture.
:::

***

## Typing Handlers in Separate Files

When you extract a handler to a standalone function, TypeScript needs a type annotation. Use `ContextOf` from `@gramio/composer`:

```ts
// src/middleware/user.ts
import { Composer } from "gramio";
import type { ContextOf } from "@gramio/composer";

export const withUser = new Composer()
    .derive(() => ({
        user: { name: "Alice", role: "admin" as "admin" | "user" },
    }))
    .as("scoped");

export type WithUser = ContextOf<typeof withUser>;
```

```ts
// src/handlers/profile.ts
import type { WithUser } from "../middleware/user";

export async function handleProfile(ctx: WithUser) {
    await ctx.send(`Hello, ${ctx.user.name}! Role: ${ctx.user.role}`);
    //                        ^? string              ^? "admin" | "user"
}
```

```ts
// src/features/profile.ts
import { Composer } from "gramio";
import { withUser } from "../middleware/user";
import { handleProfile } from "../handlers/profile";

export const profileRouter = new Composer()
    .extend(withUser)
    .command("profile", handleProfile);
```

***

## Static Dependencies with decorate()

For things that don't change per request — database clients, config, service instances — use `decorate()` instead of `derive()`. It assigns the value once at startup:

```ts
// src/middleware/deps.ts
import { Composer } from "gramio";
import { db } from "../db";
import { config } from "../config";

export const withDeps = new Composer()
    .decorate({ db, config })
    .as("scoped");
```

```ts
// src/features/admin.ts
import { Composer } from "gramio";
import { withDeps } from "../middleware/deps";

export const adminRouter = new Composer()
    .extend(withDeps)
    .command("stats", async (ctx) => {
        const count = await ctx.db.countUsers();
        //                   ^? your DB type
        ctx.send(`Users: ${count} (env: ${ctx.config.environment})`);
    });
```

***

## Suggested File Structure

```
src/
  bot.ts                  ← assembles everything
  middleware/
    user.ts               ← withUser (derive + as scoped)
    deps.ts               ← withDeps (decorate + as scoped)
  features/
    start.ts              ← /start, /help
    profile.ts            ← /profile, /settings
    admin.ts              ← /ban, /stats (with guard)
    shop.ts               ← /buy, /balance
  handlers/               ← extracted handler functions (typed)
    profile.ts
    admin.ts
```

```ts
// src/bot.ts
import { Bot } from "gramio";
import { withDeps }      from "./middleware/deps";
import { withUser }      from "./middleware/user";
import { startRouter }   from "./features/start";
import { profileRouter } from "./features/profile";
import { adminRouter }   from "./features/admin";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(withDeps)       // db, config — available everywhere
    .extend(withUser)       // ctx.user — available everywhere
    .extend(startRouter)
    .extend(profileRouter)
    .extend(adminRouter)
    .onError(({ kind, error }) => console.error(kind, error))
    .start();
```

***

## Composer vs Plugin

`Plugin` does not expose the full `Composer` API — for example `when()`, `branch()`, `inspect()`, and `trace()` are not available on `Plugin`. For internal bot structure, always prefer `Composer`.

Use `Plugin` only when:

* You're publishing a reusable package for others to `bot.extend()`
* You need to hook into the **API request lifecycle** (`preRequest`, `onResponse`, `onResponseError`) — these hooks are only available on `Plugin`, not `Composer`

```ts
import { Plugin } from "gramio";

// ✅ Plugin — for distribution or API lifecycle hooks
export const rateLimitPlugin = new Plugin("rate-limit")
    .preRequest((ctx) => {
        console.log("→", ctx.method);
        return ctx;
    });

// ✅ Composer — for everything else inside your own bot
import { Composer } from "gramio";
const adminRouter = new Composer()
    .guard((ctx) => ctx.from?.id === ADMIN_ID)
    .command("ban", (ctx) => ctx.send("Banned!"));
```

***

## Summary

| What | How |
|------|-----|
| Split handlers into files | `new Composer()` per feature, `bot.extend(router)` |
| Share `ctx.user` across modules | `withUser.as("scoped")` + extend it first in `bot.ts` |
| Add DB / config to context | `decorate({ db, config }).as("scoped")` |
| Type a handler in a separate file | `ContextOf<typeof composer>` from `@gramio/composer` |
| Guard a whole module | `.guard(predicate)` at the top of the Composer chain |
| Internal module / router | `Composer` — full API, prefer for your own bot |
| Distributable package or API lifecycle hooks | `Plugin` — `preRequest` / `onResponse` only here |

---

---
url: 'https://gramio.dev/bot-api.md'
---

# Bot API

> [Telegram Bot API documentation](https://core.telegram.org/bots/api)

[Bot API](https://core.telegram.org/bots/api) is a high-level HTTP interface to the Telegram API that makes it easy to develop bots.
Under the hood, [Bot API](https://core.telegram.org/bots/api) uses TDLib (which in turn uses MTProto API).

While the [Bot API](https://core.telegram.org/bots/api) can only be used to work with bot accounts, the MTProto API can be used to work with both bot and user accounts.
If you need to work with MTProto, we recommend you the&#x20;
mtcute library.

## Calling the Bot API

You can call Telegram Bot API methods via `bot.api` or via the shorthand methods of contexts (for example, `context.send` is `sendMessage` shorthand)

```ts twoslash
import { Bot } from "gramio";

const bot = new Bot("");
// ---cut---
const response = await bot.api.sendMessage({
    // ^?
    //
    //
    chat_id: "@gramio_forum",
    text: "some text",
});
```

```ts twoslash
import { Bot } from "gramio";

const bot = new Bot("");
// ---cut---
bot.on("message", (context) =>
    context.send("This message will be sent to the current chat")
);
```

## Telegram API Reference

GramIO ships a full [Telegram Bot API reference](/telegram/) — every method and type, kept in sync with the official API and enriched with GramIO-specific content.

### What's on each method page

Every method has its own page at `/telegram/methods/{methodName}` (e.g. [`sendMessage`](/telegram/methods/sendMessage)):

| Section | What you get |
|---------|-------------|
| **Parameters** | Every field — type, required/optional, description |
| **GramIO usage** | TypeScript examples via `bot.api.*` and context shorthands |
| **Errors** | Common error codes with root-cause explanations |
| **Tips & Gotchas** | Edge cases, limits, and common mistakes |
| **See also** | Related methods and guides |

### What's on each type page

Types live at `/telegram/types/{TypeName}` (e.g. [`Message`](/telegram/types/Message)) — every field with its type and description, linked to related types.

### Quick links

**Common methods:**
[`sendMessage`](/telegram/methods/sendMessage) · [`sendPhoto`](/telegram/methods/sendPhoto) · [`editMessageText`](/telegram/methods/editMessageText) · [`answerCallbackQuery`](/telegram/methods/answerCallbackQuery) · [`answerInlineQuery`](/telegram/methods/answerInlineQuery) · [`getChat`](/telegram/methods/getChat) · [`getChatMember`](/telegram/methods/getChatMember)

**Core types:**
[`Message`](/telegram/types/Message) · [`User`](/telegram/types/User) · [`Chat`](/telegram/types/Chat) · [`Update`](/telegram/types/Update) · [`InlineKeyboardMarkup`](/telegram/types/InlineKeyboardMarkup) · [`CallbackQuery`](/telegram/types/CallbackQuery)

[Browse the full reference →](/telegram/)

***

### Suppressing errors

It can be convenient to handle an error on the spot without using **try/catch** blocks. That's why the `suppress` argument was created, which you can use in **any** API method.

```ts twoslash
import { Bot, TelegramError } from "gramio";

const bot = new Bot("");
// ---cut---
const response = await bot.api.sendMessage({
    // ^?
    //
    //
    suppress: true,
    chat_id: "@not_found",
    text: "Suppressed method",
});

if (response instanceof TelegramError)
    console.error("sendMessage returns an error...");
else console.log("Message has been sent successfully");
```

## Handling Rate Limits

Built-in utility for 429 errors:

```ts twoslash
import { Bot } from "gramio";

const bot = new Bot("");
// ---cut---
import { withRetries } from "gramio/utils";

const response = await withRetries(() =>
    bot.api.sendMessage({
        chat_id: "@gramio_forum",
        text: "message text",
    })
);
response;
// ^?
```

`withRetries` handles both thrown and returned errors with automatic retry logic.

### Types

GramIO re-exports [@gramio/types](https://www.npmjs.com/package/@gramio/types) (Code-generated and Auto-published Telegram Bot API types).

[Read more](/types.html)

```ts twoslash
import type { APIMethodParams, APIMethodReturn } from "gramio";

type SendMessageParams = APIMethodParams<"sendMessage">;
//   ^? type SendMessageParams = SendMessageParams
//

type GetMeReturn = APIMethodReturn<"getMe">;
//   ^? type GetMeReturn = TelegramUser
//
```

For example you can use it in your custom function.

```ts twoslash
import type { APIMethodParams } from "gramio";

// ---cut---
function myCustomSend(params: APIMethodParams<"sendMessage">) {
    params;
    // ^?
}
```

#### Types for suppressed method

```ts twoslash
import type {
    SuppressedAPIMethodParams,
    SuppressedAPIMethodReturn,
} from "gramio";

type SendMessageParams = SuppressedAPIMethodParams<"sendMessage">;
//   ^? type SendMessageParams = SendMessageParams
//

type GetMeReturn = SuppressedAPIMethodReturn<"getMe">;
//   ^? type GetMeReturn = TelegramUser
//
```

### Calling API Methods Not Present in Types

First, check if they exist in [@gramio/types](https://github.com/gramiojs/types).

If they exist there but aren't visible in GramIO, you can override the dependency version in your `package.json`:

```json
{
    "overrides": {
        "@gramio/types": "10.0.0"
    }
}
```

If they don't exist (e.g., when using a custom Telegram Bot API server), you can use [declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html):

```ts
declare module "@gramio/types" {
    export interface APIMethods {
        myCustomMethod: (params: {
            chat_id: string;
            text: string;
        }) => Promise<"some return type">;
    }
}
```

Now you can use `myCustomMethod` as a regular API method:

```ts
bot.api.myCustomMethod({
    chat_id: "123",
    text: "Hello",
});
```

### Debugging

In order to debug which requests GramIO sends, you can set the environment variable to `DEBUG=gramio:api:*`

```bash
npx cross-env DEBUG=gramio:api:* node index.js
```

And you will see something like in the console:

```bash
gramio:api:getUpdates options: {"method":"POST","headers":{"Content-Type":"application/json"},"body":"{\"offset\":0,\"suppress\":true}"} +0ms
gramio:api:getUpdates response: {"ok":true,"result":[]} +49ms
```

also if you use [Bun](https://bun.sh) you can use `BUN_CONFIG_VERBOSE_FETCH` environment variable to log network requests. [Read more](https://bun.sh/docs/runtime/debugger#debugging-network-requests).

```sh
BUN_CONFIG_VERBOSE_FETCH=curl bun src/index.ts
```

And logs will looks like:

```bash [curl]
[fetch] > HTTP/1.1 POST https://example.com/
[fetch] > content-type: application/json
[fetch] > Connection: keep-alive
[fetch] > User-Agent: Bun/1.1.14
[fetch] > Accept: */*
[fetch] > Host: example.com
[fetch] > Accept-Encoding: gzip, deflate, br
[fetch] > Content-Length: 13

[fetch] < 200 OK
[fetch] < Accept-Ranges: bytes
[fetch] < Cache-Control: max-age=604800
[fetch] < Content-Type: text/html; charset=UTF-8
[fetch] < Date: Tue, 18 Jun 2024 05:12:07 GMT
[fetch] < Etag: "3147526947"
[fetch] < Expires: Tue, 25 Jun 2024 05:12:07 GMT
[fetch] < Last-Modified: Thu, 17 Oct 2019 07:18:26 GMT
[fetch] < Server: EOS (vny/044F)
[fetch] < Content-Length: 1256
```

### Bun startup optimization: --fetch-preconnect

If you are running your bot with [Bun](https://bun.sh), you can use the CLI flag `--fetch-preconnect=<url>` to speed up the first network request to Telegram servers. This flag tells Bun to start establishing the connection (DNS, TCP, TLS) to the specified host before your code runs, so the first API call is faster.

Example:

```bash
bun --fetch-preconnect=https://api.telegram.org:443/ ./src/bot.ts
```

This is especially useful for bots where the first thing you do is call the Telegram API. With this flag, Bun will "warm up" the connection at startup, so your bot will be ready to send requests with less delay. The overall startup time may increase slightly, but the time to first successful API call will decrease. In most cases this is not an issue, but the benefit is less noticeable if the first request is sent immediately after the process starts.

See more in the [Bun documentation](https://bun.sh/docs/api/fetch#preconnect-to-a-host).

---

---
url: 'https://gramio.dev/types.md'
---

# Telegram Bot API types

> Code-generated and Auto-published Telegram Bot API types

[API Types References](https://jsr.io/@gramio/types/doc)

### Versioning

7.7.x types is for 7.7 Telegram Bot API

## Usage as an [NPM package](https://www.npmjs.com/package/@gramio/types)

```ts twoslash
import type { APIMethods, APIMethodReturn } from "@gramio/types";

type SendMessageReturn = Awaited<ReturnType<APIMethods["sendMessage"]>>;
//   ^? type SendMessageReturn = TelegramMessage

type GetMeReturn = APIMethodReturn<"getMe">;
//   ^? type GetMeReturn = TelegramUser
```

### Auto-update package

This library is updated automatically to the latest version of the Telegram Bot API in case of changes thanks to CI CD!
If the github action failed, there are no changes in the bot api

## Imports

* `index` - exports everything in the section
* `methods` - exports `APIMethods` which describes the api functions
* `objects` - exports objects with the `Telegram` prefix (for example [Update](https://core.telegram.org/bots/api/#update))
* `params` - exports params that are used in `methods`

### Write you own type-safe Telegram Bot API wrapper

```ts twoslash
import type {
    APIMethods,
    APIMethodParams,
    TelegramAPIResponse,
} from "@gramio/types";

const TBA_BASE_URL = "https://api.telegram.org/bot";
const TOKEN = "";

const api = new Proxy({} as APIMethods, {
    get:
        <T extends keyof APIMethods>(_target: APIMethods, method: T) =>
        async (params: APIMethodParams<T>) => {
            const response = await fetch(`${TBA_BASE_URL}${TOKEN}/${method}`, {
                method: "POST",
                headers: {
                    "Content-Type": "application/json",
                },
                body: JSON.stringify(params),
            });

            const data = (await response.json()) as TelegramAPIResponse;
            if (!data.ok) throw new Error(`Some error occurred in ${method}`);

            return data.result;
        },
});

api.sendMessage({
    chat_id: 1,
    text: "message",
});
```

#### Usage with [`@gramio/keyboards`](https://github.com/gramiojs/keyboards)

```typescript twoslash
import type {
    APIMethods,
    APIMethodParams,
    TelegramAPIResponse,
} from "@gramio/types";

const TBA_BASE_URL = "https://api.telegram.org/bot";
const TOKEN = "";

const api = new Proxy({} as APIMethods, {
    get:
        <T extends keyof APIMethods>(_target: APIMethods, method: T) =>
        async (params: APIMethodParams<T>) => {
            const response = await fetch(`${TBA_BASE_URL}${TOKEN}/${method}`, {
                method: "POST",
                headers: {
                    "Content-Type": "application/json",
                },
                body: JSON.stringify(params),
            });

            const data = (await response.json()) as TelegramAPIResponse;
            if (!data.ok) throw new Error(`Some error occurred in ${method}`);

            return data.result;
        },
});
// ---cut---
import { Keyboard } from "@gramio/keyboards";

// the code from the example above

api.sendMessage({
    chat_id: 1,
    text: "message with keyboard",
    reply_markup: new Keyboard().text("button text"),
});
```

### With file upload support

See [files/usage-without-gramio](/files/usage-without-gramio)

## Generate types manually

Prerequire - [`rust`](https://www.rust-lang.org/)

1. Clone [this repo](https://github.com/gramiojs/types) and open it

```bash
git clone https://github.com/gramiojs/types.git
```

2. Clone [repo](https://github.com/ark0f/tg-bot-api) with Telegram Bot API schema generator

```bash
git clone https://github.com/ark0f/tg-bot-api.git
```

3. Run the JSON schema generator in the `cloned` folder

```bash
cd tg-bot-api && cargo run --package gh-pages-generator --bin gh-pages-generator -- dev && cd ..
```

4. Run types code-generation from the `root` of the project

```bash
bun generate
```

or, if you don't use `bun`, use `tsx`

```bash
npx tsx src/index.ts
```

5. Profit! Check out the types of Telegram Bot API in `out` folder!

---

---
url: 'https://gramio.dev/tma/overview.md'
---

# Telegram Mini Apps (Web app)

Guide is WIP.

For start, we recommend [`Telegram apps (tma.js)`](https://docs.telegram-mini-apps.com/).

[Telegram documentation](https://core.telegram.org/bots/webapps) | [Figma UI Kit](https://www.figma.com/file/AwAi6qE11mQllHa1sOROYp/Telegram-Mini-Apps-Library?type=design\&node-id=26%3A1081\&mode=design\&t=Sck9CgzgyKz3iIFt-1) | [Telegram Developers Community](https://t.me/devs)

## Scaffold monorepo

With [create-gramio](https://github.com/gramiojs/create-gramio) you can easily start developing Telegram mini app in monorepo. You can start a project with [tma.js](https://docs.telegram-mini-apps.com/), [Elysiajs](https://elysiajs.com/) and GramIO in a minute!

::: pm-create gramio@latest ./bot
:::

and choose the type of project you need!

For example, this is what a monorepo created using [create-gramio](https://github.com/gramiojs/create-gramio) looks like

```bash [tree]
├── apps
│   ├── bot
│   ├── mini-app
│   └── server
└── packages
    └── db
```

### Scaffold via [`Telegram apps (tma.js)`](https://docs.telegram-mini-apps.com/)

::: pm-create @telegram-apps/mini-app@latest ./bot
:::

This command will help you scaffold a project with a template that matches you from the list:

* TypeScript
* * [React](https://github.com/Telegram-Mini-Apps/reactjs-template)
* * [Solid](https://github.com/Telegram-Mini-Apps/solidjs-template)
* * [Next](https://github.com/Telegram-Mini-Apps/nextjs-template)
* JavaScript
* * [React](https://github.com/Telegram-Mini-Apps/reactjs-js-template)
* * [Solid](https://github.com/Telegram-Mini-Apps/solidjs-js-template)

> \[!WARNING]
> At the moment, `create-gramio`'s monorepo support may not be ideal (not the most convenient out of the box). because it's difficult to support these two creation options at the same time.

## HTTPS on localhost

BotFather only accepts **http://** links and getting into the **test environment** can be problematic, so let's figure out how to work with **https://** and **localhost**.

1. First you need to install [mkcert](https://github.com/FiloSottile/mkcert):

::: code-group

```bash [Windows]
choco install mkcert
# or with Scoop
scoop bucket add extras
scoop install mkcert
```

```bash [macOS]
brew install mkcert
brew install nss # if you use Firefox
```

```bash [Linux]
sudo apt install libnss3-tools
brew install mkcert
```

:::

2. Then you need to create a local certificate for the custom hostname and instal it:

```bash
mkcert mini-app.local
mkcert --install
```

3. Add the custom hostname to your hosts file:

::: code-group

```powershell [Windows (Open terminal as an administrator)]
echo "127.0.0.1 mini-app.local" >> C:\Windows\System32\drivers\etc\hosts
```

```bash [macOS | Linux]
sudo echo "127.0.0.1 mini-app.local" >> /etc/hosts
```

:::

4. Configure it in `vite.config.ts`

```ts
import fs from "node:fs";
import { defineConfig } from "vite";

export default defineConfig({
    server: {
        port: 443,
        host: "0.0.0.0",
        hmr: {
            host: "mini-app.local",
            port: 443,
        },
        https: {
            key: fs.readFileSync("./mini-app.local-key.pem"),
            cert: fs.readFileSync("./mini-app.local.pem"),
        },
    },
});
```

🔥 Now you don't need any tunnels and you are happy to develop with HMR in the telegram production environment!

![](/tma-https-on-localhost.png)

---

---
url: 'https://gramio.dev/guides/telegram-stars.md'
---

# Telegram Stars Payments in GramIO

> [Official Telegram Documentation](https://core.telegram.org/bots/payments-stars)

Telegram Stars is an in-app virtual currency that allows users to purchase digital goods and services directly in bots. This guide will show you how to implement Stars payments in your GramIO bot.

## Implementation Overview

### 1. Create Payment Handler

```typescript
bot.command("buy", async (context) => {
    const invoice = await context.bot.api.sendInvoice({
        chat_id: context.chat.id,
        title: "Premium Subscription",
        description: "1 month of premium features",
        payload: "sub_123",
        currency: "XTR",
        prices: [{ label: "1 Month", amount: 500 }], // 500 Stars = $5
    });

    return context.send("Invoice created!");
});
```

### 2. Handle Pre-Checkout Queries

```typescript
bot.on("pre_checkout_query", async (context) => {
    // Validate inventory/availability here
    await context.bot.api.answerPreCheckoutQuery({
        pre_checkout_query_id: context.id,
        ok: true,
    });
});
```

### 3. Process Successful Payments

```typescript
bot.on("successful_payment", async (context) => {
    await context.send("Payment received! Delivering goods...");
    // Implement your delivery logic here
});
```

## Key Implementation Details

### Creating Invoices

#### Pay Button

```typescript
// Substrings “⭐” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.
const keyboard = new InlineKeyboard().pay("XTR Buy Now");

context.send("Premium Features", {
    reply_markup: keyboard,
    // ... other message parameters
});
```

#### Link

```ts
const link = await context.bot.api.createInvoiceLink({
    title: "Premium Subscription",
    description: "1 month of premium features",
    payload: "sub_123",
    currency: "XTR",
    subscription_period: 2592000,
    prices: [{ label: "1 Month", amount: 500 }], // 500 Stars = $5
});
```

### Inline Query Message

```ts
context.answer(
    [
        InlineQueryResult.article(
            "id-1",
            "Premium Subscription",
            InputMessageContent.invoice({
                title: "Premium Subscription",
                description: "1 month of premium features",
                payload: "sub_123",
                currency: "XTR",
                prices: [{ label: "1 Month", amount: 500 }], // 500 Stars = $5
            })
        ),
    ],
    {
        cache_time: 0,
    }
);
```

### Testing Payments

Enable test environment:

```typescript
const bot = new Bot(process.env.BOT_TOKEN, {
    api: {
        useTest: true, // Use Telegram's test environment
    },
});
```

### Handling Disputes

Implement refund logic using Telegram's API:

```typescript
bot.command("refund", async (context) => {
    const result = await context.api.refundStarPayment({
        user_id: context.from.id,
        telegram_payment_charge_id: paymentId,
    });
});
```

> Always check current rates in [Telegram's official documentation](https://core.telegram.org/bots/payments)

[Learn more about monetization](https://promote.telegram.org/)

---

---
url: 'https://gramio.dev/changelogs/2026-02-23.md'
---

# Testing Gets Richer, CallbackData Gets Safer, TypeScript API Reference Launches

**February 18–22, 2026**

A dense week across the whole GramIO ecosystem. `@gramio/test` v0.3.0 ships 9 new methods — `editMessage`, `forwardMessage`, `sendMediaGroup`, `pinMessage`, `clickByText`, three new media senders, `ChatObject.post()` for channel bots, plus `env.clearApiCalls()` and `env.lastApiCall()` helpers. `@gramio/callback-data` v0.1.0 introduces `safeUnpack()` — a result-typed unpacker that never throws — and makes adding optional fields to existing schemas fully backward-compatible. A brand-new `@gramio/schema-parser` package replaces the Rust-based `tg-bot-api` crate powering `@gramio/types`, bringing precise `InputFile | string` unions, semantic type markers, a synthesized `Currencies` enum including `XTR`, and the previously missing `APIResponse*` types. On the unreleased front: `@gramio/composer` gets filter-only `.on()` with `CompatibleEvents<TEventMap, Narrowing>` auto-discovery and a typed `Patch` generic on `use()`; `gramio` itself gains filter-only `.on()` overloads and a full `filters.*` predicate library with `forwardOrigin(type?)` and `senderChat(type?)` narrowing. The documentation push is equally large — a full TypeDoc API reference at `/api/`, 200+ Telegram Bot API method pages at `/telegram/`, a new Cheat Sheet, JSX and Split plugin pages, interactive middleware and broadcast visualizers, a Composer production architecture guide, expanded session and formatting anti-pattern docs, and a global copy-as-Markdown button on every page.

## [@gramio/test v0.3.0 — More Actors, More Actions](https://github.com/gramiojs/test/compare/v0.1.0...v0.3.0)

### [9 new methods: edit, forward, pin, media group, and clickByText](https://github.com/gramiojs/test/commit/236e7a3651b1e34552a7a2a0eb8d0e9f163cc1a1)

The test library got a significant API expansion. Here's everything that shipped:

**`user.editMessage(msg, text)`** — emits an `edited_message` update. Test edit handlers without boilerplate:

```ts
const msg = await user.sendMessage("Hello");
await user.editMessage(msg, "Hello, world!");
expect(env.apiCalls[0].method).toBe("editMessageText");
```

**`user.forwardMessage(msg, toChat?)`** — emits a `message` update with `forward_origin` set. Useful for testing forward-detection logic:

```ts
const msg = await user.sendMessage("Original message");
await user.forwardMessage(msg, group); // forwarded to group
```

**`user.sendMediaGroup(chat, payloads[])`** — emits multiple `message` updates sharing the same `media_group_id`. Tests album handling:

```ts
await user.sendMediaGroup(group, [{ photo: {} }, { video: {} }]);
```

**`user.pinMessage(msg, inChat?)`** — emits a service message with `pinned_message` set. GramIO routes these to the `"pinned_message"` event:

```ts
const msg = await user.sendMessage("Important announcement");
await user.pinMessage(msg);
```

**`user.on(msg).clickByText(buttonText)`** — scans the message's `inline_keyboard` for a button whose `text` matches, then clicks its `callback_data`. Throws if no match is found:

```ts
// (bot replies with an inline keyboard: "Yes" and "No" buttons)
await user.on(botReply).clickByText("Yes");
```

**Three new media send methods**: `sendAudio()`, `sendAnimation()`, `sendVideoNote()` — with auto-generated file IDs and the same API as existing media methods:

```ts
await user.sendAudio({ caption: "Great track" });
await user.sendAnimation(group, { caption: "Funny gif" });
await user.sendVideoNote(); // circle video
```

**`ChatObject.post(text)`** — emits a `channel_post` update (no `from` field) for testing channel bots:

```ts
const channel = env.createChat({ type: "channel", title: "My Channel" });
await channel.post("New post from channel");
```

### [env.clearApiCalls() and env.lastApiCall()](https://github.com/gramiojs/test/commit/236e7a3651b1e34552a7a2a0eb8d0e9f163cc1a1)

Two new environment helpers for cleaner assertions:

```ts
// Reset the call log between test phases
env.clearApiCalls();

// Get the last call for a specific method
const lastSend = env.lastApiCall("sendMessage");
expect(lastSend?.params.text).toBe("Welcome!");
```

***

## [@gramio/callback-data v0.1.0 — safeUnpack() & Backward-Compatible Schemas](https://github.com/gramiojs/callback-data/compare/v0.0.11...v0.1.0)

### [safeUnpack() — never crash on stale buttons](https://github.com/gramiojs/callback-data/commit/758952458e1793709abc8cfa16f1d1d377comp)

Inline keyboard buttons live in Telegram's chat history for days or weeks. If your schema changes in the meantime, `unpack()` throws on old buttons. The new `safeUnpack()` wraps it and never throws — instead it returns a typed discriminated union.

> **Note:** If you use `bot.callbackQuery(schema, handler)`, unpacking is done automatically — you get `ctx.queryData` fully typed and never need `safeUnpack`. It's useful when you're handling `callback_query` with `bot.on()` or want to support multiple schema versions in one handler.

```ts
const data = new CallbackData("action").number("id").string("type");

// Only useful outside bot.callbackQuery() — e.g. a generic catch-all handler
bot.on("callback_query", (ctx) => {
    const result = data.safeUnpack(ctx.data ?? "");
    if (!result.success) {
        // button from an old schema version
        return ctx.answerCallbackQuery({ text: "This button is outdated!" });
    }

    ctx.answerCallbackQuery({ text: `ID: ${result.data.id}` }); // fully typed
});
```

The return type is `SafeUnpackResult<T>` — exported for your own type-guard usage.

### [Adding optional fields is now backward-compatible](https://github.com/gramiojs/callback-data/commit/758952458e1793709abc8cfa16f1d1d377cc6a98)

Previously, adding any field to a schema (even optional ones) would break existing packed strings. Now, when deserializing data that was packed without a bitmask, all optional fields are treated as absent — giving them their default or `undefined`. **Adding optional fields to the end of a schema is now a safe migration:**

```ts
// v1 schema (packed strings already exist in chat history)
const v1 = new CallbackData("page").number("id");

// v2 schema — adding optional field is safe!
const v2 = new CallbackData("page")
    .number("id")
    .string("tab", { optional: true }); // new field

// Old v1-packed strings unpack fine in v2
const result = v2.safeUnpack(v1PackedString);
// result.success === true, result.data.tab === undefined
```

Breaking schema operations (adding required fields, changing field order, renaming `nameId`) are still unsafe — document your schema history accordingly.

***

## [@gramio/schema-parser v1.0.1 — New Internal Schema Engine](https://github.com/gramiojs/schema-parser)

A new TypeScript package that parses the Telegram Bot API documentation HTML into a structured, type-annotated schema. It powers `@gramio/types` — replacing the previous dependency on the Rust-based `tg-bot-api` crate.

The schema supports:

* **Semantic type markers** — `semanticType: "formattable"` for text fields, `"markup"` for keyboard objects, `"updateType"` for context types
* **File upload detection** — string fields accepting file uploads become `InputFile | string` unions
* **Currency enum** — synthesizes a `Currencies` type from Telegram's `currencies.json`, including `XTR` (Telegram Stars)
* **Proper const values** — boolean literals `true`/`false` instead of generic strings
* **oneOf support** — union types with links and descriptions parsed correctly

***

## [@gramio/types v9.4.2 — Native Schema, Better Semantic Types](https://github.com/gramiojs/types/compare/v9.4.1...v9.4.2)

Migrated from `tg-bot-api` (Rust crate) to `@gramio/schema-parser` (TypeScript). The generated output now has:

* More precise `InputFile | string` unions for file upload parameters
* Formattable fields typed via semantic markers
* `Currencies` enum covering all supported currencies including `XTR` for Stars payments
* `APIResponse`, `APIResponseOk`, `APIResponseError` types added (previously missing)

***

## [@gramio/composer — Filter-Only .on() & CompatibleEvents (Upcoming)](https://github.com/gramiojs/composer/compare/v0.2.0...main)

New features landed in `composer`'s `main` branch alongside the gramio filter work:

### [Filter-only .on() overload in Composer](https://github.com/gramiojs/composer/commit/8fed0eb)

The composer now supports calling `.on(filter, handler)` without an event name. A `CompatibleEvents<TEventMap, Narrowing>` utility type auto-discovers which events contain all the keys the predicate narrows to:

```ts
// Type-narrowing predicate — composer finds matching events automatically
app.on(
    (ctx): ctx is { text: string } => typeof ctx.text === "string",
    (ctx) => {
        ctx.text; // string — narrowed, and handler only fires on events that have .text
    },
);
```

### [Patch generic on use()](https://github.com/gramiojs/composer/commit/d61b74b)

`use<Patch extends object>(handler)` now accepts a type parameter for local context extension without changing `TOut` for downstream middleware:

```ts
app.use<{ requestId: string }>((ctx, next) => {
    ctx.requestId = crypto.randomUUID();
    return next();
});
```

***

## [gramio — New Filter System (Upcoming)](https://github.com/gramiojs/gramio/compare/v0.5.0...main)

Not in a release yet, but significant filter work landed on `main`:

### [Filter-only .on() overloads](https://github.com/gramiojs/gramio/commit/17b4f67b0e4e96ee6cec7e5e87cba7c4aa7e39fd)

Call `.on()` with just a predicate — without specifying an event name. GramIO auto-discovers compatible events from the type-narrowing predicate:

```ts
// Type-narrowing predicate — narrows context type in the handler
bot.on(
    (ctx): ctx is { text: string } => typeof ctx.text === "string",
    (ctx) => {
        ctx.text; // string (not string | undefined)
    },
);
```

### [New message property filters](https://github.com/gramiojs/gramio/commit/5ac7cf31bc94a4a56a15e3e5f98a2b2e56b6c0ae)

Standalone predicate functions for type-narrowing in handlers:

```ts
import { filters } from "gramio";

bot.on("message", filters.reply, (ctx) => {
    ctx.replyMessage; // guaranteed to exist
});

bot.on("message", filters.entities, handler); // has entities
bot.on("message", filters.quote, handler); // has quoted reply
bot.on("message", filters.isBot, handler); // from is a bot
bot.on("message", filters.isPremium, handler); // sender has Premium
```

### [forwardOrigin() and senderChat() as callable overloads](https://github.com/gramiojs/gramio/commit/affb6cf6bc8f5dc8f6ee6b1d39b02deeffd3f1d6)

Previously separate filters, now a single callable overload with optional type narrowing:

```ts
// Narrows to messages forwarded from a user
bot.on("message", filters.forwardOrigin("user"), (ctx) => {
    ctx.forwardOrigin; // MessageOriginUser — fully typed
});

// No argument — matches any forwarded message
bot.on("message", filters.forwardOrigin(), handler);
```

***

## Documentation

This period saw a large documentation push — new guides, interactive visualizers, and a full Telegram Bot API reference built from scratch.

### [TypeScript API Reference launched at /api/](https://github.com/gramiojs/documentation/commit/1727817b6b3f3ac82bcb1e8f9f048cae01dc6c1)

A full TypeDoc-generated API reference is now at [`/api/`](/api/). It covers all core and plugin packages — `gramio`, `@gramio/contexts`, `@gramio/types`, `@gramio/keyboards`, `@gramio/callback-data`, `@gramio/composer`, and a dozen plugins. The sidebar is auto-generated and flattens internal module paths for readability.

### [Telegram Bot API Reference — 200+ methods at /telegram/](https://github.com/gramiojs/documentation/commit/16c41693ff3b01b54ded1c56e2da1ccf0e95a4a2)

Over 200 Telegram Bot API methods and types now have dedicated pages. Each page has GramIO usage examples, parameter tables (with constraints, types, enum values, and required/optional indicators), error tables, and related method cross-references. The `ApiParam` component renders inline type badges that link to related Telegram types. Clickable type badges, italic `True`/`False` literals, multipart badges, and `docsLink` annotations for Files/Keyboards/Formattable cross-references were all added this cycle ([`da3a4eb`](https://github.com/gramiojs/documentation/commit/da3a4eb), [`526b4db`](https://github.com/gramiojs/documentation/commit/526b4db), [`b2167cc`](https://github.com/gramiojs/documentation/commit/b2167cc)).

### [Cheat Sheet page](https://github.com/gramiojs/documentation/commit/7baeefd)

A quick-reference cheat sheet is now in the nav at [`/cheat-sheet`](/cheat-sheet). Common GramIO patterns in one place — no more digging through guide pages for the right method signature.

### [JSX plugin documentation](https://github.com/gramiojs/documentation/commit/3f0c07f)

New page at [`/plugins/official/jsx`](/plugins/official/jsx) covering the `@gramio/jsx` plugin — text formatting, inline and reply keyboard builders with JSX, and bilingual usage examples.

### [Split plugin documentation expanded](https://github.com/gramiojs/documentation/commit/fdc00a9)

The `@gramio/split` page at [`/plugins/official/split`](/plugins/official/split) now has full installation steps, detailed API reference, entity splitting mechanics explanation, custom limit examples, and framework-agnostic usage patterns.

### [Interactive middleware pipeline visualizer](https://github.com/gramiojs/documentation/commit/dbbc57e)

The middleware guide grew an interactive `UpdatePipelineVisualizer` component — toggle update types, simulate debug mode, and watch the context flow in real time without reading walls of text.

### [Rate limits docs — BroadcastVisualizer & deep dive](https://github.com/gramiojs/documentation/commit/6e68f3d)

The rate limits page got a `BroadcastVisualizer` component and a detailed breakdown of HTTP 429 mechanics, broadcast anti-patterns (the naive `for` loop), and a comparison of simple loop vs `@gramio/broadcast` vs BullMQ — with timing diagrams.

### [@gramio/composer production architecture guide](https://github.com/gramiojs/documentation/commit/095e0fd)

The composer reference now covers Named Composer deduplication mechanics, isolation group internals, scoped/global propagation patterns, and the dedup/shared-data gotcha. A production architecture pattern with `withUser`/router assembly is included ([`bcc0c8f`](https://github.com/gramiojs/documentation/commit/bcc0c8f)).

### [Formatting anti-patterns](https://github.com/gramiojs/documentation/commit/3dad7f8)

Critical rules added to the formatting guide:

```ts
// ❌ WRONG — never use parse_mode with @gramio/format entities
ctx.send({ text: format`${bold("hi")}`, parse_mode: "HTML" });

// ❌ WRONG — never .join() Formattable arrays (loses entity offsets)
[bold("a"), italic("b")].join(", ");

// ✅ CORRECT — use the join() helper from @gramio/format
import { join } from "gramio";
join([bold("a"), italic("b")], ", ");
```

### [Session plugin docs expanded](https://github.com/gramiojs/documentation/commit/561c7bd)

The session docs now cover lazy loading, `$clear()` for session deletion, custom session key functions for per-chat vs per-user-per-chat scoping, and explicit TypeScript typing for both eager and lazy session modes.

### [Copy/Download as Markdown on every page](https://github.com/gramiojs/documentation/commit/ef03b7f)

The `CopyOrDownloadAsMarkdownButtons` component is now globally registered — every documentation page has a one-click button to copy or download its content as clean Markdown, useful for feeding docs into AI assistants.

---

---
url: 'https://gramio.dev/testing.md'
---

# Testing

[![npm](https://img.shields.io/npm/v/@gramio/test?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/test)
[![npm downloads](https://img.shields.io/npm/dw/@gramio/test?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/test)
[![JSR](https://jsr.io/badges/@gramio/test)](https://jsr.io/@gramio/test)
[![JSR Score](https://jsr.io/badges/@gramio/test/score)](https://jsr.io/@gramio/test)

An event-driven test framework for bots built with GramIO. Users are the primary actors — they send messages, join/leave chats, click inline buttons — and the framework manages in-memory state and emits the correct Telegram updates to the bot under test. No real HTTP requests are made.

## Installation

::: pm-add -D @gramio/test
:::

## Quick Start

```ts
import { describe, expect, it } from "bun:test";
import { Bot } from "gramio";
import { TelegramTestEnvironment } from "@gramio/test";

describe("My bot", () => {
    it("should reply to /start", async () => {
        const bot = new Bot("test");
        bot.command("start", (ctx) => ctx.send("Welcome!"));

        const env = new TelegramTestEnvironment(bot);
        const user = env.createUser({ first_name: "Alice" });

        await user.sendMessage("/start");

        expect(env.apiCalls[0].method).toBe("sendMessage");
    });
});
```

## `TelegramTestEnvironment`

The central orchestrator. Wraps a GramIO `Bot`, intercepts all outgoing API calls, and provides factories for users and chats.

```ts
const bot = new Bot("test");
const env = new TelegramTestEnvironment(bot);
```

| Property / Method | Description |
|---|---|
| `env.createUser(payload?)` | Creates a `UserObject` linked to the environment |
| `env.createChat(payload?)` | Creates a `ChatObject` (group, supergroup, channel, etc.) |
| `env.emitUpdate(update)` | Sends a raw `TelegramUpdate` or `MessageObject` to the bot |
| `env.onApi(method, handler)` | Override the response for a specific API method |
| `env.offApi(method?)` | Remove a handler (or all handlers if no method given) |
| `env.apiCalls` | Array of `{ method, params, response }` recording every API call |
| `env.clearApiCalls()` | Empties the `apiCalls` array (useful between logical test phases) |
| `env.lastApiCall(method)` | Returns the most recent recorded call for `method`, or `undefined` |
| `env.users` / `env.chats` | All created users and chats |

## `UserObject` — the primary actor

Users drive the test scenario. Create them via `env.createUser()`:

```ts
const user = env.createUser({ first_name: "Alice" });
```

### `user.sendMessage(text)` — send a PM to the bot

```ts
const msg = await user.sendMessage("Hello");
```

### `user.sendMessage(chat, text)` — send a message to a group

```ts
const group = env.createChat({ type: "group", title: "Test Group" });
await user.sendMessage(group, "/start");
```

### `user.join(chat)` / `user.leave(chat)`

Emits a `chat_member` update and a service message (`new_chat_members` / `left_chat_member`). Updates `chat.members` set.

```ts
await user.join(group);
expect(group.members.has(user)).toBe(true);

await user.leave(group);
expect(group.members.has(user)).toBe(false);
```

### `user.click(callbackData, message?)`

Emits a `callback_query` update. Perfect for testing inline keyboard interactions:

```ts
const msg = await user.sendMessage("Pick an option");
await user.click("option:1", msg);
```

### `user.editMessage(msg, text)` — simulate message editing

Emits an `edited_message` update. Test `bot.on("edited_message", ...)` handlers:

```ts
const msg = await user.sendMessage("Hello");
await user.editMessage(msg, "Hello, world!");
```

### `user.forwardMessage(msg, toChat?)` — forward a message

Emits a `message` update with `forward_origin` set. Tests forward-detection logic:

```ts
const msg = await user.sendMessage("Original");
await user.forwardMessage(msg, group);
```

### `user.sendMediaGroup(chat, payloads[])` — send an album

Emits multiple `message` updates sharing the same `media_group_id`:

```ts
await user.sendMediaGroup(group, [
    { photo: {} },
    { video: {} },
]);
```

### `user.pinMessage(msg, inChat?)` — pin a message

Emits a service message with `pinned_message`. GramIO routes these to the `"pinned_message"` event:

```ts
const msg = await user.sendMessage("Important!");
await user.pinMessage(msg);
```

### Media send methods

In addition to existing methods (`sendPhoto`, `sendVideo`, `sendDocument`, `sendVoice`, `sendSticker`), three new ones are available — all with auto-generated file IDs:

```ts
await user.sendAudio({ caption: "Track title" });
await user.sendAnimation(group, { caption: "Funny gif" });
await user.sendVideoNote(); // circle video
```

### `user.react(emojiOrObject, message?, options?)` — react to a message

Emits a `message_reaction` update. Works with `bot.reaction()` handlers:

```ts
const msg = await user.sendMessage("Nice bot!");

// Single emoji
await user.react("👍", msg);

// Multiple emojis
await user.react(["👍", "❤"], msg);

// Declare previous reactions (old_reaction)
await user.react("❤", msg, { oldReactions: ["👍"] });
```

Use the `ReactObject` builder for fine-grained control:

```ts
import { ReactObject } from "@gramio/test";

await user.react(
    new ReactObject()
        .on(msg)          // attach to message (infers chat)
        .add("👍", "🔥") // new_reaction
        .remove("😢")    // old_reaction
);

// Attribute the reaction to a different user:
await alice.react(new ReactObject().from(bob).on(msg).add("👍"));
```

**Automatic reaction state tracking**: `MessageObject` tracks per-user reactions in memory. When `user.react()` is called, `old_reaction` is computed automatically from the in-memory state — you only need `oldReactions` when you want to override:

```ts
await user.react("👍", msg);  // old_reaction = [] (auto)
await user.react("❤", msg);  // old_reaction = ["👍"] — auto-computed!
```

### `user.sendInlineQuery(query, chatOrOptions?, options?)` — trigger inline mode

Emits an `inline_query` update. Works with `bot.inlineQuery()` handlers:

```ts
// No chat context
const q = await user.sendInlineQuery("search cats");

// With chat — chat_type derived automatically
const group = env.createChat({ type: "group" });
const q2 = await user.sendInlineQuery("search cats", group);

// With pagination offset
const q3 = await user.sendInlineQuery("search dogs", { offset: "10" });

// With chat + offset
const q4 = await user.sendInlineQuery("search dogs", group, { offset: "10" });
```

### `user.chooseInlineResult(resultId, query, options?)` — simulate result selection

Emits a `chosen_inline_result` update:

```ts
await user.chooseInlineResult("result-1", "search cats");
await user.chooseInlineResult("result-1", "search cats", { inline_message_id: "abc" });
```

### `user.in(chat)` — scope to a chat

Returns a `UserInChatScope` with the chat pre-bound. Makes chained operations more readable:

```ts
const group = env.createChat({ type: "group" });

await user.in(group).sendMessage("Hello group!");
await user.in(group).sendInlineQuery("cats");
await user.in(group).join();
await user.in(group).leave();

// Chain further to a message:
const msg = await user.sendMessage(group, "Pick one");
await user.in(group).on(msg).react("👍");
await user.in(group).on(msg).click("choice:A");
```

### `user.on(msg)` — scope to a message

Returns a `UserOnMessageScope` for message-level actions:

```ts
const msg = await user.sendMessage("Hello");

await user.on(msg).react("👍");
await user.on(msg).react("❤", { oldReactions: ["👍"] });
await user.on(msg).click("action:1");

// clickByText — find button by label and click it
await user.on(botReply).clickByText("Confirm");
```

`clickByText(buttonText)` scans the message's `inline_keyboard` for a button whose `text` matches, then clicks its `callback_data`. Throws if no inline keyboard is present or no button matches.

## `ChatObject`

Wraps `TelegramChat` with in-memory state tracking:

* **`chat.members`** — `Set<UserObject>` of current members
* **`chat.messages`** — `MessageObject[]` history of all messages in the chat

### `chat.post(text)` — simulate a channel post

Emits a `channel_post` update (no `from` field). For testing channel bots:

```ts
const channel = env.createChat({ type: "channel", title: "My Channel" });
await channel.post("New post from channel");
```

## `MessageObject`

Wraps `TelegramMessage` with builder methods:

```ts
const message = new MessageObject({ text: "Hello" })
    .from(user)
    .chat(group);
```

## `CallbackQueryObject`

Wraps `TelegramCallbackQuery` with builder methods:

```ts
const cbQuery = new CallbackQueryObject()
    .from(user)
    .data("action:1")
    .message(msg);
```

## `ReactObject`

Chainable builder for `message_reaction` updates:

| Method | Description |
|--------|-------------|
| `.from(user)` | Set the user who reacted (auto-filled by `user.react()`) |
| `.on(message)` | Attach to a message and infer the chat |
| `.inChat(chat)` | Override the chat explicitly |
| `.add(...emojis)` | Emojis being added (`new_reaction`) |
| `.remove(...emojis)` | Emojis being removed (`old_reaction`) |

```ts
const reaction = new ReactObject()
    .on(msg)
    .add("👍", "🔥")
    .remove("😢");

await user.react(reaction);
```

## `InlineQueryObject`

Wraps `TelegramInlineQuery` with builder methods:

```ts
const inlineQuery = new InlineQueryObject()
    .from(user)
    .query("search cats")
    .offset("0");
```

## `ChosenInlineResultObject`

Wraps `TelegramChosenInlineResult` with builder methods:

```ts
const result = new ChosenInlineResultObject()
    .from(user)
    .resultId("result-1")
    .query("search cats");
```

## Inspecting Bot API Calls

The environment intercepts all outgoing API calls (no real HTTP requests) and records them:

```ts
const bot = new Bot("test");
bot.on("message", async (ctx) => {
    await ctx.send("Reply!");
});

const env = new TelegramTestEnvironment(bot);
const user = env.createUser();

await user.sendMessage("Hello");

expect(env.apiCalls).toHaveLength(1);
expect(env.apiCalls[0].method).toBe("sendMessage");
expect(env.apiCalls[0].params.text).toBe("Reply!");
```

## Mocking API Responses

Use `env.onApi()` to control what the bot receives from the Telegram API. Accepts a static value or a dynamic handler function:

```ts
// Static response
env.onApi("getMe", { id: 1, is_bot: true, first_name: "TestBot" });

// Dynamic response based on params
env.onApi("sendMessage", (params) => ({
    message_id: 1,
    date: Date.now(),
    chat: { id: params.chat_id, type: "private" },
    text: params.text,
}));
```

### Simulating Errors

Use `apiError()` to create a `TelegramError` that the bot will receive as a rejected promise — matching exactly how real Telegram API errors work in GramIO:

```ts
import { TelegramTestEnvironment, apiError } from "@gramio/test";

// Bot is blocked by user
env.onApi("sendMessage", apiError(403, "Forbidden: bot was blocked by the user"));

// Rate limiting
env.onApi("sendMessage", apiError(429, "Too Many Requests", { retry_after: 30 }));

// Conditional — error for some chats, success for others
env.onApi("sendMessage", (params) => {
    if (params.chat_id === blockedUserId) {
        return apiError(403, "Forbidden: bot was blocked by the user");
    }
    return {
        message_id: 1,
        date: Date.now(),
        chat: { id: params.chat_id, type: "private" },
        text: params.text,
    };
});
```

### Resetting

```ts
env.offApi("sendMessage"); // reset specific method
env.offApi();              // reset all overrides
```

---

---
url: 'https://gramio.dev/troubleshooting.md'
---
# Troubleshooting

// TODO:

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/AllowedUpdates.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / AllowedUpdates

# Type Alias: AllowedUpdates

> **AllowedUpdates** = `Exclude`<`NonNullable`<[`APIMethodParams`](APIMethodParams.md)<`"getUpdates"`>>\[`"allowed_updates"`], `"update_id"`>

Defined in: gramio/index.d.ts:821

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/AnyBot.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / AnyBot

# Type Alias: AnyBot

> **AnyBot** = [`Bot`](../classes/Bot.md)<`any`, `any`, `any`>

Defined in: gramio/index.d.ts:813

Type of Bot that accepts any generics

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/AnyPlugin.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / AnyPlugin

# Type Alias: AnyPlugin

> **AnyPlugin** = [`Plugin`](../classes/Plugin.md)<`any`, `any`, `any`>

Defined in: gramio/index.d.ts:815

Type of Bot that accepts any generics

---

---
url: 'https://gramio.dev/api/scenes/type-aliases/AnyScene.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / AnyScene

# Type Alias: AnyScene

> **AnyScene** = [`Scene`](../classes/Scene.md)<`any`, `any`, `any`, `any`>

Defined in: scenes/index.d.ts:206

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/APIMethodParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / APIMethodParams

# Type Alias: APIMethodParams\<APIMethod>

> **APIMethodParams**<`APIMethod`> = `Parameters`<[`APIMethods`](../interfaces/APIMethods.md)\[`APIMethod`]>\[`0`]

Defined in: @gramio/types/out/utils.d.ts:34

## Type Parameters

| Type Parameter |
| ------ |
| `APIMethod` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |

## Example

```typescript
type SendMessageParams = APIMethodParams<"sendMessage">;
//   ^? type SendMessageParams = SendMessageParams"
```

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/APIMethodReturn.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / APIMethodReturn

# Type Alias: APIMethodReturn\<APIMethod>

> **APIMethodReturn**<`APIMethod`> = `Awaited`<`ReturnType`<[`APIMethods`](../interfaces/APIMethods.md)\[`APIMethod`]>>

Defined in: @gramio/types/out/utils.d.ts:44

## Type Parameters

| Type Parameter |
| ------ |
| `APIMethod` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |

## Example

```typescript
type SendMessageReturn = APIMethodReturn<"sendMessage">;
//   ^? type SendMessageReturn = TelegramMessage"
```

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/AttachmentType.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / AttachmentType

# Type Alias: AttachmentType

> **AttachmentType** = [`TelegramInputMedia`](../../../../gramio/type-aliases/TelegramInputMedia.md)\[`"type"`] | `"sticker"` | `"video_note"` | `"voice"` | `"contact"` | `"poll"` | `"venue"` | `"location"` | `"story"`

Defined in: contexts/index.d.ts:202

Union type of attachments type

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/BotStartOptionsLongPolling.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / BotStartOptionsLongPolling

# Type Alias: BotStartOptionsLongPolling

> **BotStartOptionsLongPolling** = `Omit`<`NonNullable`<[`APIMethodParams`](APIMethodParams.md)<`"getUpdates"`>>, `"allowed_updates"` | `"offset"`>

Defined in: gramio/index.d.ts:819

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/BotStartOptionsWebhook.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / BotStartOptionsWebhook

# Type Alias: BotStartOptionsWebhook

> **BotStartOptionsWebhook** = `true` | `string` | `Omit`<[`SetWebhookParams`](../interfaces/SetWebhookParams.md), `"drop_pending_updates"` | `"allowed_updates"`>

Defined in: gramio/index.d.ts:820

---

---
url: 'https://gramio.dev/api/keyboards/type-aliases/ButtonsIterator.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / ButtonsIterator

# Type Alias: ButtonsIterator()\<T>

> **ButtonsIterator**<`T`> = (`options`) => `boolean`

Defined in: keyboards/index.d.ts:11

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | { `button`: `T`; `index`: `number`; `row`: `T`\[]; `rowIndex`: `number`; } |
| `options.button` | `T` |
| `options.index` | `number` |
| `options.row` | `T`\[] |
| `options.rowIndex` | `number` |

## Returns

`boolean`

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/CallbackQueryShorthandContext.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / CallbackQueryShorthandContext

# Type Alias: CallbackQueryShorthandContext\<BotType, Trigger>

> **CallbackQueryShorthandContext**<`BotType`, `Trigger`> = `Omit`<[`ContextType`](../../../contexts/type-aliases/ContextType.md)<`BotType`, `"callback_query"`>, `"data"`> & `BotType`\[`"__Derives"`]\[`"global"`] & `BotType`\[`"__Derives"`]\[`"callback_query"`] & `object`

Defined in: gramio/index.d.ts:816

## Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `queryData` | `Trigger` *extends* [`CallbackData`](../../../callback-data/classes/CallbackData.md) ? `ReturnType`<`Trigger`\[`"unpack"`]> : `Trigger` *extends* `RegExp` ? `RegExpMatchArray` : `never` | gramio/index.d.ts:817 |

## Type Parameters

| Type Parameter |
| ------ |
| `BotType` *extends* [`BotLike`](../../../contexts/interfaces/BotLike.md) |
| `Trigger` *extends* [`CallbackData`](../../../callback-data/classes/CallbackData.md) | `string` | `RegExp` |

---

---
url: 'https://gramio.dev/api/composer/type-aliases/CompatibleEvents.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / CompatibleEvents

# Type Alias: CompatibleEvents\<TEventMap, Narrowing>

> **CompatibleEvents**<`TEventMap`, `Narrowing`> = `{ [E in keyof TEventMap & string]: (keyof Narrowing & string) extends keyof TEventMap[E] ? E : never }`\[keyof `TEventMap` & `string`]

Defined in: composer/index.d.ts:233

Given an event map and a Narrowing type, yields the union of event names
whose context type contains all keys from Narrowing.

## Type Parameters

| Type Parameter |
| ------ |
| `TEventMap` *extends* `Record`<`string`, `any`> |
| `Narrowing` |

---

---
url: 'https://gramio.dev/api/composer/type-aliases/ComposedMiddleware.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / ComposedMiddleware

# Type Alias: ComposedMiddleware()\<T>

> **ComposedMiddleware**<`T`> = (`context`, `next?`) => `Promise`<`unknown`>

Defined in: composer/index.d.ts:6

Composed middleware: next is optional (acts as terminal continuation)

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | `T` |
| `next?` | [`Next`](Next.md) |

## Returns

`Promise`<`unknown`>

---

---
url: 'https://gramio.dev/api/composer/type-aliases/ComposerLike.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / ComposerLike

# Type Alias: ComposerLike\<T>

> **ComposerLike**<`T`> = `object`

Defined in: composer/index.d.ts:257

Minimal structural type for constraining `this` in custom composer methods.

Use as an F-bounded constraint on `TThis` so that `this.on(...)` is typed
and returns `TThis` without requiring `as any`:

## Example

```ts
command<TThis extends ComposerLike<TThis>>(
  this: TThis,
  name: string,
  handler: Middleware<MsgCtx & ContextOf<TThis>>,
): TThis {
  const inner: Middleware<MsgCtx & ContextOf<TThis>> = (ctx, next) => {
    if (ctx.text === `/${name}`) return handler(ctx, next);
    return next();
  };
  return this.on("message", inner); // typed — no cast needed
}
```

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` | `unknown` |

## Methods

### on()

> **on**(`event`, `handler`): `T`

Defined in: composer/index.d.ts:258

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | `any` |
| `handler` | `any` |

#### Returns

`T`

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/Constructor.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Constructor

# Type Alias: Constructor()\<T>

> **Constructor**<`T`> = (...`args`) => `T`

Defined in: contexts/index.d.ts:210

Type helper constructor

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` | `object` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

## Returns

`T`

---

---
url: 'https://gramio.dev/api/composer/type-aliases/ContextOf.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / ContextOf

# Type Alias: ContextOf\<T>

> **ContextOf**<`T`> = `T` *extends* `object` ? `O` : `never`

Defined in: composer/index.d.ts:377

Extracts the current accumulated context type (`TOut`) from an EventComposer
or Composer instance type.

Use with a `this: TThis` parameter in custom methods to get automatic
derive type inference — the handler receives all types from previous `.derive()` calls
without requiring explicit annotation at the call site.

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Example

```ts
const { Composer } = createComposer({
  methods: {
    // Automatic: caller's derives are inferred into the handler
    command<TThis>(
      this: TThis,
      name: string,
      handler: Middleware<MessageCtx & ContextOf<TThis>>,
    ) {
      return (this as any).on("message", (ctx: any, next: any) => {
        if (ctx.text === `/${name}`) return handler(ctx, next);
        return next();
      }) as TThis;
    },

    // Manual: caller declares which derives they need via Patch generic
    hears<Patch extends object = {}>(
      trigger: string,
      handler: Middleware<MessageCtx & Patch>,
    ) {
      return this.on<"message", Patch>("message", (ctx, next) => {
        if (ctx.text === trigger) return handler(ctx, next);
        return next();
      });
    },
  },
});

// With ContextOf — no type annotation needed at call site:
new Composer()
  .derive(() => ({ user: { id: 1 } }))
  .command("start", (ctx) => ctx.user.id); // ✅ inferred automatically

// With Patch — caller declares what they need:
new Composer()
  .derive(() => ({ user: { id: 1 } }))
  .hears<{ user: { id: number } }>("hello", (ctx) => ctx.user.id); // ✅
```

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/ContextsMapping.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ContextsMapping

# Type Alias: ContextsMapping\<Bot>

> **ContextsMapping**<`Bot`> = `object`

Defined in: contexts/index.d.ts:105

Mapping events to their contexts

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `boost_added` | [`BoostAddedContext`](../classes/BoostAddedContext.md)<`Bot`> | contexts/index.d.ts:138 |
|  `business_connection` | [`BusinessConnectionContext`](../classes/BusinessConnectionContext.md)<`Bot`> | contexts/index.d.ts:125 |
|  `business_message` | [`MessageContextWithRequiredFrom`](MessageContextWithRequiredFrom.md)<`Bot`> | contexts/index.d.ts:122 |
|  `callback_query` | [`CallbackQueryContext`](../classes/CallbackQueryContext.md)<`Bot`> | contexts/index.d.ts:106 |
|  `channel_post` | [`MessageContext`](../classes/MessageContext.md)<`Bot`> | contexts/index.d.ts:119 |
|  `chat_background_set` | [`ChatBackgroundSetContext`](../classes/ChatBackgroundSetContext.md)<`Bot`> | contexts/index.d.ts:139 |
|  `chat_boost` | [`ChatBoostContext`](../classes/ChatBoostContext.md)<`Bot`> | contexts/index.d.ts:173 |
|  `chat_join_request` | [`ChatJoinRequestContext`](../classes/ChatJoinRequestContext.md)<`Bot`> | contexts/index.d.ts:107 |
|  `chat_member` | [`ChatMemberContext`](../classes/ChatMemberContext.md)<`Bot`> | contexts/index.d.ts:108 |
|  `chat_owner_changed` | [`ChatOwnerChangedContext`](../classes/ChatOwnerChangedContext.md)<`Bot`> | contexts/index.d.ts:163 |
|  `chat_owner_left` | [`ChatOwnerLeftContext`](../classes/ChatOwnerLeftContext.md)<`Bot`> | contexts/index.d.ts:162 |
|  `chat_shared` | [`ChatSharedContext`](../classes/ChatSharedContext.md)<`Bot`> | contexts/index.d.ts:158 |
|  `checklist_tasks_added` | [`ChecklistTasksAddedContext`](../classes/ChecklistTasksAddedContext.md)<`Bot`> | contexts/index.d.ts:141 |
|  `checklist_tasks_done` | [`ChecklistTasksDoneContext`](../classes/ChecklistTasksDoneContext.md)<`Bot`> | contexts/index.d.ts:140 |
|  `chosen_inline_result` | [`ChosenInlineResultContext`](../classes/ChosenInlineResultContext.md)<`Bot`> | contexts/index.d.ts:110 |
|  `delete_chat_photo` | [`DeleteChatPhotoContext`](../classes/DeleteChatPhotoContext.md)<`Bot`> | contexts/index.d.ts:111 |
|  `deleted_business_messages` | [`BusinessMessagesDeletedContext`](../classes/BusinessMessagesDeletedContext.md)<`Bot`> | contexts/index.d.ts:124 |
|  `direct_message_price_changed` | [`DirectMessagePriceChangedContext`](../classes/DirectMessagePriceChangedContext.md)<`Bot`> | contexts/index.d.ts:142 |
|  `edited_business_message` | [`MessageContextWithRequiredFrom`](MessageContextWithRequiredFrom.md)<`Bot`> | contexts/index.d.ts:123 |
|  `edited_channel_post` | [`MessageContextWithRequiredFrom`](MessageContextWithRequiredFrom.md)<`Bot`> | contexts/index.d.ts:121 |
|  `edited_message` | [`MessageContextWithRequiredFrom`](MessageContextWithRequiredFrom.md)<`Bot`> | contexts/index.d.ts:120 |
|  `forum_topic_closed` | [`ForumTopicClosedContext`](../classes/ForumTopicClosedContext.md)<`Bot`> | contexts/index.d.ts:150 |
|  `forum_topic_created` | [`ForumTopicCreatedContext`](../classes/ForumTopicCreatedContext.md)<`Bot`> | contexts/index.d.ts:148 |
|  `forum_topic_edited` | [`ForumTopicEditedContext`](../classes/ForumTopicEditedContext.md)<`Bot`> | contexts/index.d.ts:149 |
|  `forum_topic_reopened` | [`ForumTopicReopenedContext`](../classes/ForumTopicReopenedContext.md)<`Bot`> | contexts/index.d.ts:151 |
|  `general_forum_topic_hidden` | [`GeneralForumTopicHiddenContext`](../classes/GeneralForumTopicHiddenContext.md)<`Bot`> | contexts/index.d.ts:152 |
|  `general_forum_topic_unhidden` | [`GeneralForumTopicUnhiddenContext`](../classes/GeneralForumTopicUnhiddenContext.md)<`Bot`> | contexts/index.d.ts:153 |
|  `gift` | [`GiftContext`](../classes/GiftContext.md)<`Bot`> | contexts/index.d.ts:159 |
|  `gift_upgrade_sent` | [`GiftUpgradeSentContext`](../classes/GiftUpgradeSentContext.md)<`Bot`> | contexts/index.d.ts:160 |
|  `giveaway_completed` | [`GiveawayCompletedContext`](../classes/GiveawayCompletedContext.md)<`Bot`> | contexts/index.d.ts:176 |
|  `giveaway_created` | [`GiveawayCreatedContext`](../classes/GiveawayCreatedContext.md)<`Bot`> | contexts/index.d.ts:175 |
|  `giveaway_winners` | [`GiveawayWinnersContext`](../classes/GiveawayWinnersContext.md)<`Bot`> | contexts/index.d.ts:177 |
|  `group_chat_created` | [`GroupChatCreatedContext`](../classes/GroupChatCreatedContext.md)<`Bot`> | contexts/index.d.ts:112 |
|  `inline_query` | [`InlineQueryContext`](../classes/InlineQueryContext.md)<`Bot`> | contexts/index.d.ts:113 |
|  `invoice` | [`InvoiceContext`](../classes/InvoiceContext.md)<`Bot`> | contexts/index.d.ts:114 |
|  `left_chat_member` | [`LeftChatMemberContext`](../classes/LeftChatMemberContext.md)<`Bot`> | contexts/index.d.ts:115 |
|  `location` | [`LocationContext`](../classes/LocationContext.md)<`Bot`> | contexts/index.d.ts:116 |
|  `message` | [`MessageContextWithRequiredFrom`](MessageContextWithRequiredFrom.md)<`Bot`> | contexts/index.d.ts:118 |
|  `message_auto_delete_timer_changed` | [`MessageAutoDeleteTimerChangedContext`](../classes/MessageAutoDeleteTimerChangedContext.md)<`Bot`> | contexts/index.d.ts:117 |
|  `message_reaction` | [`MessageReactionContext`](../classes/MessageReactionContext.md)<`Bot`> | contexts/index.d.ts:171 |
|  `message_reaction_count` | [`MessageReactionCountContext`](../classes/MessageReactionCountContext.md)<`Bot`> | contexts/index.d.ts:172 |
|  `migrate_from_chat_id` | [`MigrateFromChatIdContext`](../classes/MigrateFromChatIdContext.md)<`Bot`> | contexts/index.d.ts:126 |
|  `migrate_to_chat_id` | [`MigrateToChatIdContext`](../classes/MigrateToChatIdContext.md)<`Bot`> | contexts/index.d.ts:127 |
|  `my_chat_member` | [`ChatMemberContext`](../classes/ChatMemberContext.md)<`Bot`> | contexts/index.d.ts:109 |
|  `new_chat_members` | [`NewChatMembersContext`](../classes/NewChatMembersContext.md)<`Bot`> | contexts/index.d.ts:128 |
|  `new_chat_photo` | [`NewChatPhotoContext`](../classes/NewChatPhotoContext.md)<`Bot`> | contexts/index.d.ts:129 |
|  `new_chat_title` | [`NewChatTitleContext`](../classes/NewChatTitleContext.md)<`Bot`> | contexts/index.d.ts:130 |
|  `paid_message_price_changed` | [`PaidMessagePriceChangedContext`](../classes/PaidMessagePriceChangedContext.md)<`Bot`> | contexts/index.d.ts:164 |
|  `passport_data` | [`PassportDataContext`](../classes/PassportDataContext.md)<`Bot`> | contexts/index.d.ts:131 |
|  `pinned_message` | [`PinnedMessageContext`](../classes/PinnedMessageContext.md)<`Bot`> | contexts/index.d.ts:132 |
|  `poll` | [`PollContext`](../classes/PollContext.md)<`Bot`> | contexts/index.d.ts:134 |
|  `poll_answer` | [`PollAnswerContext`](../classes/PollAnswerContext.md)<`Bot`> | contexts/index.d.ts:133 |
|  `pre_checkout_query` | [`PreCheckoutQueryContext`](../classes/PreCheckoutQueryContext.md)<`Bot`> | contexts/index.d.ts:135 |
|  `proximity_alert_triggered` | [`ProximityAlertTriggeredContext`](../classes/ProximityAlertTriggeredContext.md)<`Bot`> | contexts/index.d.ts:136 |
|  `purchased_paid_media` | [`PaidMediaPurchasedContext`](../classes/PaidMediaPurchasedContext.md)<`Bot`> | contexts/index.d.ts:178 |
|  `refunded_payment` | [`RefundedPaymentContext`](../classes/RefundedPaymentContext.md)<`Bot`> | contexts/index.d.ts:156 |
|  `removed_chat_boost` | [`RemovedChatBoostContext`](../classes/RemovedChatBoostContext.md)<`Bot`> | contexts/index.d.ts:174 |
|  `service_message` | [`MessageContext`](../classes/MessageContext.md)<`Bot`> | contexts/index.d.ts:170 |
|  `shipping_query` | [`ShippingQueryContext`](../classes/ShippingQueryContext.md)<`Bot`> | contexts/index.d.ts:154 |
|  `successful_payment` | [`SuccessfulPaymentContext`](../classes/SuccessfulPaymentContext.md)<`Bot`> | contexts/index.d.ts:155 |
|  `suggested_post_approval_failed` | [`SuggestedPostApprovalFailedContext`](../classes/SuggestedPostApprovalFailedContext.md)<`Bot`> | contexts/index.d.ts:144 |
|  `suggested_post_approved` | [`SuggestedPostApprovedContext`](../classes/SuggestedPostApprovedContext.md)<`Bot`> | contexts/index.d.ts:143 |
|  `suggested_post_declined` | [`SuggestedPostDeclinedContext`](../classes/SuggestedPostDeclinedContext.md)<`Bot`> | contexts/index.d.ts:145 |
|  `suggested_post_paid` | [`SuggestedPostPaidContext`](../classes/SuggestedPostPaidContext.md)<`Bot`> | contexts/index.d.ts:146 |
|  `suggested_post_refunded` | [`SuggestedPostRefundedContext`](../classes/SuggestedPostRefundedContext.md)<`Bot`> | contexts/index.d.ts:147 |
|  `unique_gift` | [`UniqueGiftContext`](../classes/UniqueGiftContext.md)<`Bot`> | contexts/index.d.ts:161 |
|  `users_shared` | [`UsersSharedContext`](../classes/UsersSharedContext.md)<`Bot`> | contexts/index.d.ts:157 |
|  `video_chat_ended` | [`VideoChatEndedContext`](../classes/VideoChatEndedContext.md)<`Bot`> | contexts/index.d.ts:165 |
|  `video_chat_participants_invited` | [`VideoChatParticipantsInvitedContext`](../classes/VideoChatParticipantsInvitedContext.md)<`Bot`> | contexts/index.d.ts:166 |
|  `video_chat_scheduled` | [`VideoChatScheduledContext`](../classes/VideoChatScheduledContext.md)<`Bot`> | contexts/index.d.ts:167 |
|  `video_chat_started` | [`VideoChatStartedContext`](../classes/VideoChatStartedContext.md)<`Bot`> | contexts/index.d.ts:168 |
|  `web_app_data` | [`WebAppDataContext`](../classes/WebAppDataContext.md)<`Bot`> | contexts/index.d.ts:169 |
|  `write_access_allowed` | [`WriteAccessAllowedContext`](../classes/WriteAccessAllowedContext.md)<`Bot`> | contexts/index.d.ts:137 |

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/ContextType.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ContextType

# Type Alias: ContextType\<Bot, Name>

> **ContextType**<`Bot`, `Name`> = `InstanceType`<[`ContextsMapping`](ContextsMapping.md)<`Bot`>\[`Name`]> & [`GetDerives`](GetDerives.md)<`Bot`, `Name`>

Defined in: contexts/index.d.ts:189

Type util to get type of Context

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |
| `Name` *extends* keyof [`ContextsMapping`](ContextsMapping.md)<`Bot`> |

## Example

```ts
type Message = ContextType<Bot, "message">;
```

---

---
url: 'https://gramio.dev/api/keyboards/type-aliases/CreateButtonIterator.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / CreateButtonIterator

# Type Alias: CreateButtonIterator()\<T>

> **CreateButtonIterator**<`T`> = (`options`) => `T`

Defined in: keyboards/index.d.ts:17

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | { `index`: `number`; `rowIndex`: `number`; } |
| `options.index` | `number` |
| `options.rowIndex` | `number` |

## Returns

`T`

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/CreateForumTopicIconColor.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / CreateForumTopicIconColor

# Type Alias: CreateForumTopicIconColor

> **CreateForumTopicIconColor** = `7322096` | `16766590` | `13338331` | `9367192` | `16749490` | `16478047`

Defined in: @gramio/types/out/params.d.ts:2276

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/CreateNewStickerSetStickerType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / CreateNewStickerSetStickerType

# Type Alias: CreateNewStickerSetStickerType

> **CreateNewStickerSetStickerType** = `"regular"` | `"mask"` | `"custom_emoji"`

Defined in: @gramio/types/out/params.d.ts:3716

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/CustomEventName.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / CustomEventName

# Type Alias: CustomEventName

> **CustomEventName** = `"service_message"`

Defined in: contexts/index.d.ts:193

Custom Event Name

---

---
url: 'https://gramio.dev/api/gramio/namespaces/Hooks/type-aliases/Derive.md'
---
[GramIO API Reference](../../../../../index.md) / [gramio/dist](../../../index.md) / [Hooks](../index.md) / Derive

# Type Alias: Derive()\<Ctx>

> **Derive**<`Ctx`> = (`context`) => [`MaybePromise`](../../../type-aliases/MaybePromise.md)<`Record`<`string`, `unknown`>>

Defined in: gramio/index.d.ts:667

Derive

## Type Parameters

| Type Parameter |
| ------ |
| `Ctx` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | `Ctx` |

## Returns

[`MaybePromise`](../../../type-aliases/MaybePromise.md)<`Record`<`string`, `unknown`>>

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/DeriveDefinitions.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / DeriveDefinitions

# Type Alias: DeriveDefinitions

> **DeriveDefinitions** = `Record`<[`UpdateName`](../../../contexts/type-aliases/UpdateName.md) | `"global"`, { }>

Defined in: gramio/index.d.ts:811

Map of derives

---

---
url: 'https://gramio.dev/api/composer/type-aliases/DeriveFromOptions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / DeriveFromOptions

# Type Alias: DeriveFromOptions\<Macros, TOptions>

> **DeriveFromOptions**<`Macros`, `TOptions`> = `UnionToIntersection`<`{ [K in keyof TOptions & keyof Macros]: MacroDeriveType<Macros[K]> }`\[keyof `TOptions` & keyof `Macros`]>

Defined in: composer/index.d.ts:101

Collects all derive types from macros that are activated in `TOptions`.
The result is intersected into the handler's context type.

## Type Parameters

| Type Parameter |
| ------ |
| `Macros` *extends* [`MacroDefinitions`](MacroDefinitions.md) |
| `TOptions` |

---

---
url: 'https://gramio.dev/api/composer/type-aliases/DeriveHandler.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / DeriveHandler

# Type Alias: DeriveHandler()\<T, D>

> **DeriveHandler**<`T`, `D`> = (`context`) => `D` | `Promise`<`D`>

Defined in: composer/index.d.ts:14

Function that computes additional context properties

## Type Parameters

| Type Parameter |
| ------ |
| `T` |
| `D` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | `T` |

## Returns

`D` | `Promise`<`D`>

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/ErrorDefinitions.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / ErrorDefinitions

# Type Alias: ErrorDefinitions

> **ErrorDefinitions** = `Record`<`string`, `Error`>

Defined in: gramio/index.d.ts:809

Error map should be map of string: error

---

---
url: 'https://gramio.dev/api/composer/type-aliases/ErrorHandler.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / ErrorHandler

# Type Alias: ErrorHandler()\<T>

> **ErrorHandler**<`T`> = (`params`) => `unknown`

Defined in: composer/index.d.ts:8

Error handler receives an object with error, context, and resolved kind

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | { `context`: `T`; `error`: `unknown`; `kind?`: `string`; } |
| `params.context` | `T` |
| `params.error` | `unknown` |
| `params.kind?` | `string` |

## Returns

`unknown`

---

---
url: 'https://gramio.dev/api/composer/type-aliases/EventContextOf.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / EventContextOf

# Type Alias: EventContextOf\<T, E>

> **EventContextOf**<`T`, `E`> = `T` *extends* `object` ? `O` & `E` *extends* keyof `D` ? `D`\[`E`] : `object` : `never`

Defined in: composer/index.d.ts:410

Extracts the context type for a specific event from an EventComposer instance,
combining global `TOut` (like `ContextOf`) **and** per-event `TDerives[E]`.

Use this in custom event-specific methods (e.g. `command`, `hears`) instead of
`ContextOf<T>` so that handlers registered via `derive(event, handler)` are
visible in the handler's type:

## Type Parameters

| Type Parameter |
| ------ |
| `T` |
| `E` *extends* `string` |

## Example

```ts
const methods = defineComposerMethods({
  command<TThis extends ComposerLike<TThis>>(
    this: TThis,
    name: string,
    handler: Middleware<MsgCtx & EventContextOf<TThis, "message">>,
  ): TThis {
    return this.on("message", (ctx, next) => {
      if (ctx.text === `/${name}`) return handler(ctx, next);
      return next();
    });
  },
});

new Composer()
  .derive("message", () => ({ t: (s: string) => s }))
  .command("start", (ctx) => ctx.t("Hi!")); // ✅ t is visible
```

---

---
url: 'https://gramio.dev/api/session/type-aliases/Events.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/session/dist](../index.md) / Events

# Type Alias: Events

> **Events** = \[`"message"`, `"callback_query"`, `"channel_post"`, `"chat_join_request"`, `"chosen_inline_result"`, `"inline_query"`, `"web_app_data"`, `"successful_payment"`, `"video_chat_started"`, `"video_chat_ended"`, `"video_chat_scheduled"`, `"video_chat_participants_invited"`, `"passport_data"`, `"new_chat_title"`, `"new_chat_photo"`, `"pinned_message"`, `"poll_answer"`, `"pre_checkout_query"`, `"proximity_alert_triggered"`, `"shipping_query"`, `"group_chat_created"`, `"delete_chat_photo"`, `"location"`, `"invoice"`, `"message_auto_delete_timer_changed"`, `"migrate_from_chat_id"`, `"migrate_to_chat_id"`, `"new_chat_members"`, `"chat_shared"`]\[`number`]

Defined in: session/index.d.ts:5

Telegram events that support session

---

---
url: 'https://gramio.dev/api/prompt/type-aliases/EventsUnion.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / EventsUnion

# Type Alias: EventsUnion

> **EventsUnion** = *typeof* `events`\[`number`]

Defined in: prompt/index.d.ts:26

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/ExtractArgsParams.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / ExtractArgsParams

# Type Alias: ExtractArgsParams\<Item>

> **ExtractArgsParams**<`Item`> = `Item` *extends* [`LocaleArgs`](LocaleArgs.md)\<infer Args> ? `Args` : \[]

Defined in: i18n/index.d.ts:16

## Type Parameters

| Type Parameter |
| ------ |
| `Item` *extends* [`LocaleItem`](LocaleItem.md) |

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/ExtractItemValue.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / ExtractItemValue

# Type Alias: ExtractItemValue\<Item, FallbackItem>

> **ExtractItemValue**<`Item`, `FallbackItem`> = \[`Item`] *extends* \[`never`] ? \[`FallbackItem`] *extends* \[`never`] ? `never` : `ExtractItemValue`<`FallbackItem`> : `Item` *extends* [`LocaleArgs`](LocaleArgs.md) ? `ReturnType`<`Item`> : `Item`

Defined in: i18n/index.d.ts:17

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Item` *extends* [`LocaleItem`](LocaleItem.md) | - |
| `FallbackItem` *extends* [`LocaleItem`](LocaleItem.md) | `never` |

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/ExtractLanguages.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / ExtractLanguages

# Type Alias: ExtractLanguages\<T>

> **ExtractLanguages**<`T`> = `T` *extends* `object` ? `Languages` : `never`

Defined in: i18n/index.d.ts:29

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/Filter.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / Filter

# Type Alias: Filter()\<In, Out>

> **Filter**<`In`, `Out`> = (`context`) => `context is Out`

Defined in: gramio/index.d.ts:1334

A type guard predicate that narrows `In` to `Out`.
Built-in filters use `any` as `In` so they work with any bot's context type.
The actual narrowing happens via intersection in the `.on()` handler type.

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `In` | `any` |
| `Out` *extends* `In` | `In` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | `In` |

## Returns

`context is Out`

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/GetDerives.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / GetDerives

# Type Alias: GetDerives\<Bot, Event>

> **GetDerives**<`Bot`, `Event`> = `Bot`\[`"__Derives"`]\[`"global"`] & `Bot`\[`"__Derives"`]\[`Event`]

Defined in: contexts/index.d.ts:102

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |
| `Event` *extends* keyof [`ContextsMapping`](ContextsMapping.md)<`Bot`> |

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/GetI18nKeys.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / GetI18nKeys

# Type Alias: GetI18nKeys\<I18n>

> **GetI18nKeys**<`I18n`> = [`NestedKeysDelimited`](NestedKeysDelimited.md)<[`ExtractLanguages`](ExtractLanguages.md)<`I18n`>\[`I18n`\[`"primaryLanguage"`]]>

Defined in: i18n/index.d.ts:35

## Type Parameters

| Type Parameter |
| ------ |
| `I18n` *extends* [`I18nOptions`](../interfaces/I18nOptions.md)<`any`, `any`> |

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/GetI18nParams.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / GetI18nParams

# Type Alias: GetI18nParams\<I18n, Key>

> **GetI18nParams**<`I18n`, `Key`> = `Key` *extends* [`NestedKeysDelimited`](NestedKeysDelimited.md)<[`ExtractLanguages`](ExtractLanguages.md)<`I18n`>>\[`I18n`\[`"primaryLanguage"`]] ? [`ExtractArgsParams`](ExtractArgsParams.md)<[`GetValueNested`](GetValueNested.md)<[`ExtractLanguages`](ExtractLanguages.md)<`I18n`>\[`I18n`\[`"primaryLanguage"`]], `Key`>> : `never`

Defined in: i18n/index.d.ts:34

## Type Parameters

| Type Parameter |
| ------ |
| `I18n` *extends* [`I18nOptions`](../interfaces/I18nOptions.md)<`any`, `any`> |
| `Key` *extends* [`NestedKeysDelimited`](NestedKeysDelimited.md)<[`ExtractLanguages`](ExtractLanguages.md)<`I18n`>>\[`I18n`\[`"primaryLanguage"`]] |

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/GetValueNested.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / GetValueNested

# Type Alias: GetValueNested\<T, K>

> **GetValueNested**<`T`, `K`> = `K` *extends* `` `${infer P}.${infer Q}` `` ? `GetValueNested`<`SafeGet`<`T`, `P`>, `Q`> : `SafeGet`<`T`, `K`>

Defined in: i18n/index.d.ts:14

## Type Parameters

| Type Parameter |
| ------ |
| `T` |
| `K` *extends* `string` |

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/GiftPremiumSubscriptionMonthCount.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / GiftPremiumSubscriptionMonthCount

# Type Alias: GiftPremiumSubscriptionMonthCount

> **GiftPremiumSubscriptionMonthCount** = `3` | `6` | `12`

Defined in: @gramio/types/out/params.d.ts:2710

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/Handler.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / Handler

# Type Alias: Handler()\<T>

> **Handler**<`T`> = (`context`, `next`) => `unknown`

Defined in: gramio/index.d.ts:600

Handler is a function with context and next function arguments

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | `T` |
| `next` | [`Next`](../../../composer/type-aliases/Next.md) |

## Returns

`unknown`

## Example

```ts
const handler: Handler<ContextType<Bot, "message">> = (context, _next) => context.send("HI!");

bot.on("message", handler)
```

---

---
url: 'https://gramio.dev/api/composer/type-aliases/HandlerOptions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / HandlerOptions

# Type Alias: HandlerOptions\<TBaseCtx, Macros>

> **HandlerOptions**<`TBaseCtx`, `Macros`> = `object` & `{ [K in keyof Macros]?: WithCtx<MacroOptionType<Macros[K]>, TBaseCtx> }`

Defined in: composer/index.d.ts:90

Builds the `options` parameter type for handler methods.
Includes `preHandler` plus all registered macro option types
with ContextCallback markers replaced by `TBaseCtx`.

## Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `preHandler?` | [`Middleware`](Middleware.md)<`TBaseCtx`> | [`Middleware`](Middleware.md)<`TBaseCtx`>\[] | composer/index.d.ts:91 |

## Type Parameters

| Type Parameter |
| ------ |
| `TBaseCtx` |
| `Macros` *extends* [`MacroDefinitions`](MacroDefinitions.md) |

---

---
url: 'https://gramio.dev/api/callback-data/type-aliases/InferDataPack.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/callback-data/dist](../index.md) / InferDataPack

# Type Alias: InferDataPack\<T>

> **InferDataPack**<`T`> = `T` *extends* [`CallbackData`](../classes/CallbackData.md)\<infer SchemaType, infer SchemaTypeInput> ? `SchemaTypeInput` : `never`

Defined in: callback-data/index.d.ts:56

## Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`CallbackData`](../classes/CallbackData.md) |

---

---
url: 'https://gramio.dev/api/callback-data/type-aliases/InferDataUnpack.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/callback-data/dist](../index.md) / InferDataUnpack

# Type Alias: InferDataUnpack\<T>

> **InferDataUnpack**<`T`> = `T` *extends* [`CallbackData`](../classes/CallbackData.md)\<infer SchemaType, infer SchemaTypeInput> ? `SchemaType` : `never`

Defined in: callback-data/index.d.ts:57

## Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`CallbackData`](../classes/CallbackData.md) |

---

---
url: 'https://gramio.dev/api/storage/type-aliases/InMemoryStorageMap.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/storage/dist](../index.md) / InMemoryStorageMap

# Type Alias: InMemoryStorageMap\<T>

> **InMemoryStorageMap**<`T`> = `Map`<`string`, { `data`: `T`; }>

Defined in: storage/index.d.ts:4

Type of in memory storage map

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` | `any` |

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/JoinUnion.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / JoinUnion

# Type Alias: JoinUnion\<T>

> **JoinUnion**<`T`> = `T` *extends* infer U ? `U` *extends* `any` ? `Record`<`string`, `any`> & `U` : `never` : `never`

Defined in: contexts/index.d.ts:197

Type helper to join union type

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

---

---
url: 'https://gramio.dev/api/keyboards/type-aliases/KeyboardHelpers.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/keyboards/dist](../index.md) / KeyboardHelpers

# Type Alias: KeyboardHelpers\<T>

> **KeyboardHelpers**<`T`> = [`KeyboardHelperColumns`](../interfaces/KeyboardHelperColumns.md) | [`KeyboardHelperWrap`](../interfaces/KeyboardHelperWrap.md)<`T`> | [`KeyboardHelperFilter`](../interfaces/KeyboardHelperFilter.md)<`T`> | [`KeyboardHelperPattern`](../interfaces/KeyboardHelperPattern.md)

Defined in: keyboards/index.d.ts:37

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/LanguagesMap.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / LanguagesMap

# Type Alias: LanguagesMap

> **LanguagesMap** = `Record`<`string`, [`LanguageMap`](../interfaces/LanguageMap.md)>

Defined in: i18n/index.d.ts:15

---

---
url: 'https://gramio.dev/api/composer/type-aliases/LazyFactory.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / LazyFactory

# Type Alias: LazyFactory()\<T>

> **LazyFactory**<`T`> = (`context`) => [`Middleware`](Middleware.md)<`T`> | `Promise`<[`Middleware`](Middleware.md)<`T`>>

Defined in: composer/index.d.ts:16

Lazy middleware factory — called per invocation

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | `T` |

## Returns

[`Middleware`](Middleware.md)<`T`> | `Promise`<[`Middleware`](Middleware.md)<`T`>>

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/LocaleArgs.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / LocaleArgs

# Type Alias: LocaleArgs()\<Arguments>

> **LocaleArgs**<`Arguments`> = (...`args`) => [`LocaleValue`](LocaleValue.md)

Defined in: i18n/index.d.ts:6

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Arguments` *extends* `any`\[] | `any`\[] |

## Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `Arguments` |

## Returns

[`LocaleValue`](LocaleValue.md)

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/LocaleItem.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / LocaleItem

# Type Alias: LocaleItem\<Arguments>

> **LocaleItem**<`Arguments`> = [`LocaleArgs`](LocaleArgs.md)<`Arguments`> | [`LocaleValue`](LocaleValue.md)

Defined in: i18n/index.d.ts:7

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Arguments` *extends* `any`\[] | `any`\[] |

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/LocaleValue.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / LocaleValue

# Type Alias: LocaleValue

> **LocaleValue** = `string` | [`FormattableString`](../../../../gramio/classes/FormattableString.md)

Defined in: i18n/index.d.ts:5

---

---
url: 'https://gramio.dev/api/composer/type-aliases/MacroDef.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / MacroDef

# Type Alias: MacroDef\<TOptions, TDerive>

> **MacroDef**<`TOptions`, `TDerive`> = (`opts`) => [`MacroHooks`](../interfaces/MacroHooks.md)<`TDerive`> | [`MacroHooks`](../interfaces/MacroHooks.md)<`TDerive`>

Defined in: composer/index.d.ts:74

A macro definition: either a function accepting options, or a plain hooks object (boolean shorthand).

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `TOptions` | `void` |
| `TDerive` *extends* `object` | `object` |

## Example

```ts
// Parameterized macro
const throttle: MacroDef<{ limit: number }, {}> = (opts) => ({
  preHandler: createThrottleMiddleware(opts),
});

// Boolean shorthand
const onlyAdmin: MacroDef<void, {}> = {
  preHandler: checkAdminMiddleware,
};
```

---

---
url: 'https://gramio.dev/api/composer/type-aliases/MacroDefinitions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / MacroDefinitions

# Type Alias: MacroDefinitions

> **MacroDefinitions** = `Record`<`string`, [`MacroDef`](MacroDef.md)<`any`, `any`>>

Defined in: composer/index.d.ts:76

Registry of named macro definitions

---

---
url: 'https://gramio.dev/api/composer/type-aliases/MacroDeriveType.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / MacroDeriveType

# Type Alias: MacroDeriveType\<M>

> **MacroDeriveType**<`M`> = `M` *extends* (`opts`) => `object` ? `Exclude`<`Awaited`<`R`>, `void`> : `M` *extends* `object` ? `Exclude`<`Awaited`<`R`>, `void`> : `object`

Defined in: composer/index.d.ts:80

Extract the derive (context enrichment) type from a macro

## Type Parameters

| Type Parameter |
| ------ |
| `M` |

---

---
url: 'https://gramio.dev/api/composer/type-aliases/MacroOptionType.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / MacroOptionType

# Type Alias: MacroOptionType\<M>

> **MacroOptionType**<`M`> = `M` *extends* (`opts`) => `any` ? `O` : `boolean`

Defined in: composer/index.d.ts:78

Extract the options type a macro accepts (boolean for shorthand macros)

## Type Parameters

| Type Parameter |
| ------ |
| `M` |

---

---
url: 'https://gramio.dev/api/init-data/type-aliases/MakeOptional.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/init-data/dist](../index.md) / MakeOptional

# Type Alias: MakeOptional\<T, K>

> **MakeOptional**<`T`, `K`> = `Omit`<`T`, `K`> & `Partial`<`Pick`<`T`, `K`>>

Defined in: init-data/index.d.ts:139

## Type Parameters

| Type Parameter |
| ------ |
| `T` |
| `K` *extends* keyof `T` |

---

---
url: 'https://gramio.dev/api/composer/type-aliases/MaybeArray.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / MaybeArray

# Type Alias: MaybeArray\<T>

> **MaybeArray**<`T`> = `T` | readonly `T`\[]

Defined in: composer/index.d.ts:18

Single value or array

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/MaybeArray.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MaybeArray

# Type Alias: MaybeArray\<T>

> **MaybeArray**<`T`> = `T` | `T`\[]

Defined in: contexts/index.d.ts:200

Type helper to add array and non-array type

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

---

---
url: 'https://gramio.dev/api/prompt/type-aliases/MaybeArray.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / MaybeArray

# Type Alias: MaybeArray\<T>

> **MaybeArray**<`T`> = `T` | `T`\[]

Defined in: prompt/index.d.ts:129

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/MaybePromise.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / MaybePromise

# Type Alias: MaybePromise\<T>

> **MaybePromise**<`T`> = `Promise`<`T`> | `T`

Defined in: gramio/index.d.ts:659

Type for maybe Promise or may not

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/MaybeSuppressedParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / MaybeSuppressedParams

# Type Alias: MaybeSuppressedParams\<Method, IsSuppressed>

> **MaybeSuppressedParams**<`Method`, `IsSuppressed`> = [`APIMethodParams`](APIMethodParams.md)<`Method`> & [`Suppress`](../interfaces/Suppress.md)<`IsSuppressed`>

Defined in: gramio/index.d.ts:640

Type that assign API params with [Suppress](../interfaces/Suppress.md)

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Method` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) | - |
| `IsSuppressed` *extends* `boolean` | `undefined` | `undefined` |

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/MaybeSuppressedReturn.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / MaybeSuppressedReturn

# Type Alias: MaybeSuppressedReturn\<Method, IsSuppressed>

> **MaybeSuppressedReturn**<`Method`, `IsSuppressed`> = `true` *extends* `IsSuppressed` ? [`TelegramError`](../classes/TelegramError.md)<`Method`> | [`APIMethodReturn`](APIMethodReturn.md)<`Method`> : [`APIMethodReturn`](APIMethodReturn.md)<`Method`>

Defined in: gramio/index.d.ts:644

Type that return MaybeSuppressed API method ReturnType

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Method` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) | - |
| `IsSuppressed` *extends* `boolean` | `undefined` | `undefined` |

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/MessageContextWithRequiredFrom.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageContextWithRequiredFrom

# Type Alias: MessageContextWithRequiredFrom\<Bot>

> **MessageContextWithRequiredFrom**<`Bot`> = [`Constructor`](Constructor.md)<`InstanceType`<[`MessageContext`](../classes/MessageContext.md)<`Bot`>> & [`Require`](Require.md)<`InstanceType`<[`MessageContext`](../classes/MessageContext.md)<`Bot`>>, `"from"`>>

Defined in: contexts/index.d.ts:103

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/MessageDraftPiece.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageDraftPiece

# Type Alias: MessageDraftPiece

> **MessageDraftPiece** = `string` | { `draft_id?`: `number`; `entities?`: [`TelegramMessageEntity`](../../../../gramio/interfaces/TelegramMessageEntity.md)\[]; `text`: `string`; }

Defined in: contexts/index.d.ts:272

A chunk of text for streaming via sendMessageDraft

## Type Declaration

`string`

{ `draft_id?`: `number`; `entities?`: [`TelegramMessageEntity`](../../../../gramio/interfaces/TelegramMessageEntity.md)\[]; `text`: `string`; }

| Name | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `draft_id?` | `number` | Optional draft identifier to control message splitting | contexts/index.d.ts:274 |
| `entities?` | [`TelegramMessageEntity`](../../../../gramio/interfaces/TelegramMessageEntity.md)\[] | Optional entities for this chunk (offsets relative to entire stream) | contexts/index.d.ts:278 |
| `text` | `string` | The text content of this chunk | contexts/index.d.ts:276 |

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/MessageEventName.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / MessageEventName

# Type Alias: MessageEventName

> **MessageEventName** = `"new_chat_members"` | `"left_chat_member"` | `"new_chat_title"` | `"new_chat_photo"` | `"delete_chat_photo"` | `"group_chat_created"` | `"message_auto_delete_timer_changed"` | `"migrate_to_chat_id"` | `"migrate_from_chat_id"` | `"pinned_message"` | `"invoice"` | `"successful_payment"` | `"refunded_payment"` | `"users_shared"` | `"chat_shared"` | `"gift"` | `"gift_upgrade_sent"` | `"unique_gift"` | `"chat_owner_left"` | `"chat_owner_changed"` | `"paid_message_price_changed"` | `"proximity_alert_triggered"` | `"write_access_allowed"` | `"forum_topic_created"` | `"forum_topic_edited"` | `"forum_topic_closed"` | `"forum_topic_reopened"` | `"general_forum_topic_hidden"` | `"general_forum_topic_unhidden"` | `"video_chat_scheduled"` | `"video_chat_started"` | `"video_chat_ended"` | `"video_chat_participants_invited"` | `"web_app_data"` | `"location"` | `"passport_data"` | `"giveaway_created"` | `"giveaway_completed"` | `"giveaway_winners"` | `"boost_added"` | `"chat_background_set"` | `"checklist_tasks_done"` | `"checklist_tasks_added"` | `"direct_message_price_changed"` | `"suggested_post_approved"` | `"suggested_post_approval_failed"` | `"suggested_post_declined"` | `"suggested_post_paid"` | `"suggested_post_refunded"`

Defined in: contexts/index.d.ts:191

Union type of MessageEvent names

---

---
url: 'https://gramio.dev/api/composer/type-aliases/Middleware.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / Middleware

# Type Alias: Middleware()\<T>

> **Middleware**<`T`> = (`context`, `next`) => `unknown`

Defined in: composer/index.d.ts:4

Middleware function: receives context and next

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | `T` |
| `next` | [`Next`](Next.md) |

## Returns

`unknown`

---

---
url: 'https://gramio.dev/api/composer/type-aliases/MiddlewareType.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / MiddlewareType

# Type Alias: MiddlewareType

> **MiddlewareType** = `"use"` | `"derive"` | `"decorate"` | `"guard"` | `"branch"` | `"route"` | `"fork"` | `"tap"` | `"lazy"` | `"group"` | `"extend"` | `"on"` | `"macro"`

Defined in: composer/index.d.ts:22

Which method created a middleware entry

---

---
url: 'https://gramio.dev/api/scenes/type-aliases/Modify.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / Modify

# Type Alias: Modify\<Base, Mod>

> **Modify**<`Base`, `Mod`> = `Omit`<`Base`, keyof `Mod`> & `Mod`

Defined in: scenes/index.d.ts:141

## Type Parameters

| Type Parameter |
| ------ |
| `Base` |
| `Mod` |

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/NestedKeysDelimited.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / NestedKeysDelimited

# Type Alias: NestedKeysDelimited\<T>

> **NestedKeysDelimited**<`T`> = `Values`<``{ [key in Extract<keyof T, string>]: T[key] extends LocaleItem ? key : `${key}.${T[key] extends infer R ? NestedKeysDelimited<R> : never}` }``>

Defined in: i18n/index.d.ts:11

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

---

---
url: 'https://gramio.dev/api/composer/type-aliases/Next.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / Next

# Type Alias: Next()

> **Next** = () => `Promise`<`unknown`>

Defined in: composer/index.d.ts:2

next() continuation function

## Returns

`Promise`<`unknown`>

---

---
url: 'https://gramio.dev/api/gramio/namespaces/Hooks/type-aliases/OnApiCall.md'
---
[GramIO API Reference](../../../../../index.md) / [gramio/dist](../../../index.md) / [Hooks](../index.md) / OnApiCall

# Type Alias: OnApiCall()\<Methods>

> **OnApiCall**<`Methods`> = (`context`, `next`) => `Promise`<`unknown`>

Defined in: gramio/index.d.ts:796

Type for `onApiCall` hook (wrap-style)

This hook wraps the entire API call execution, enabling span creation
around API calls for tracing/instrumentation.

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Methods` *extends* keyof [`APIMethods`](../../../interfaces/APIMethods.md) | keyof [`APIMethods`](../../../interfaces/APIMethods.md) |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`OnApiCallContext`](OnApiCallContext.md)<`Methods`> |
| `next` | () => `Promise`<`unknown`> |

## Returns

`Promise`<`unknown`>

## Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).onApiCall(async (context, next) => {
    console.log(`Calling ${context.method}`);
    const result = await next();
    console.log(`${context.method} completed`);
    return result;
});
```

---

---
url: >-
  https://gramio.dev/api/gramio/namespaces/Hooks/type-aliases/OnApiCallContext.md
---
[GramIO API Reference](../../../../../index.md) / [gramio/dist](../../../index.md) / [Hooks](../index.md) / OnApiCallContext

# Type Alias: OnApiCallContext\<Methods>

> **OnApiCallContext**<`Methods`> = `AnyTelegramMethod`<`Methods`>

Defined in: gramio/index.d.ts:777

Argument type for [OnApiCall](OnApiCall.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Methods` *extends* keyof [`APIMethods`](../../../interfaces/APIMethods.md) |

---

---
url: 'https://gramio.dev/api/gramio/namespaces/Hooks/type-aliases/OnError.md'
---
[GramIO API Reference](../../../../../index.md) / [gramio/dist](../../../index.md) / [Hooks](../index.md) / OnError

# Type Alias: OnError()\<T, Ctx>

> **OnError**<`T`, `Ctx`> = (`options`) => `unknown`

Defined in: gramio/index.d.ts:714

Type for `onError` hook

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` *extends* [`ErrorDefinitions`](../../../type-aliases/ErrorDefinitions.md) | - |
| `Ctx` *extends* [`Context`](../../../../../contexts/classes/Context.md)<`any`> | [`Context`](../../../../../contexts/classes/Context.md)<[`AnyBot`](../../../type-aliases/AnyBot.md)> |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | [`OnErrorContext`](OnErrorContext.md)<`Ctx`, `T`> |

## Returns

`unknown`

## Example

```typescript
bot.on("message", () => {
    bot.api.sendMessage({
        chat_id: "@not_found",
        text: "Chat not exists....",
    });
});

bot.onError(({ context, kind, error }) => {
    if (context.is("message")) return context.send(`${kind}: ${error.message}`);
});
```

[Documentation](https://gramio.dev/hooks/on-error.html)

---

---
url: 'https://gramio.dev/api/gramio/namespaces/Hooks/type-aliases/OnErrorContext.md'
---
[GramIO API Reference](../../../../../index.md) / [gramio/dist](../../../index.md) / [Hooks](../index.md) / OnErrorContext

# Type Alias: OnErrorContext\<Ctx, T>

> **OnErrorContext**<`Ctx`, `T`> = `ErrorHandlerParams`<`Ctx`, `"TELEGRAM"`, `AnyTelegramError`> | `ErrorHandlerParams`<`Ctx`, `"UNKNOWN"`, `Error`> | `{ [K in keyof T]: ErrorHandlerParams<Ctx, K & string, T[K & string]> }`\[keyof `T`]

Defined in: gramio/index.d.ts:692

Argument type for [OnError](OnError.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Ctx` *extends* [`Context`](../../../../../contexts/classes/Context.md)<[`AnyBot`](../../../type-aliases/AnyBot.md)> |
| `T` *extends* [`ErrorDefinitions`](../../../type-aliases/ErrorDefinitions.md) |

---

---
url: 'https://gramio.dev/api/gramio/namespaces/Hooks/type-aliases/OnResponse.md'
---
[GramIO API Reference](../../../../../index.md) / [gramio/dist](../../../index.md) / [Hooks](../index.md) / OnResponse

# Type Alias: OnResponse()\<Methods>

> **OnResponse**<`Methods`> = (`context`) => `unknown`

Defined in: gramio/index.d.ts:775

Type for `onResponse` hook

[Documentation](https://gramio.dev/hooks/on-response.html)

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Methods` *extends* keyof [`APIMethods`](../../../interfaces/APIMethods.md) | keyof [`APIMethods`](../../../interfaces/APIMethods.md) |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | `AnyTelegramMethodWithReturn`<`Methods`> |

## Returns

`unknown`

---

---
url: 'https://gramio.dev/api/gramio/namespaces/Hooks/type-aliases/OnResponseError.md'
---
[GramIO API Reference](../../../../../index.md) / [gramio/dist](../../../index.md) / [Hooks](../index.md) / OnResponseError

# Type Alias: OnResponseError()\<Methods>

> **OnResponseError**<`Methods`> = (`context`, `api`) => `unknown`

Defined in: gramio/index.d.ts:769

Type for `onResponseError` hook

[Documentation](https://gramio.dev/hooks/on-response-error.html)

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Methods` *extends* keyof [`APIMethods`](../../../interfaces/APIMethods.md) | keyof [`APIMethods`](../../../interfaces/APIMethods.md) |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | `AnyTelegramError`<`Methods`> |
| `api` | [`Bot`](../../../classes/Bot.md)\[`"api"`] |

## Returns

`unknown`

---

---
url: 'https://gramio.dev/api/gramio/namespaces/Hooks/type-aliases/OnStart.md'
---
[GramIO API Reference](../../../../../index.md) / [gramio/dist](../../../index.md) / [Hooks](../index.md) / OnStart

# Type Alias: OnStart()

> **OnStart** = (`context`) => `unknown`

Defined in: gramio/index.d.ts:735

Type for `onStart` hook

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | { `info`: [`TelegramUser`](../../../interfaces/TelegramUser.md); `plugins`: `string`\[]; `updatesFrom`: `"webhook"` | `"long-polling"`; } |
| `context.info` | [`TelegramUser`](../../../interfaces/TelegramUser.md) |
| `context.plugins` | `string`\[] |
| `context.updatesFrom` | `"webhook"` | `"long-polling"` |

## Returns

`unknown`

## Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).onStart(
    ({ plugins, info, updatesFrom }) => {
        console.log(`plugin list - ${plugins.join(", ")}`);
        console.log(`bot username is @${info.username}`);
		   console.log(`updates from ${updatesFrom}`);
    }
);

bot.start();
```

[Documentation](https://gramio.dev/hooks/on-start.html)

---

---
url: 'https://gramio.dev/api/gramio/namespaces/Hooks/type-aliases/OnStop.md'
---
[GramIO API Reference](../../../../../index.md) / [gramio/dist](../../../index.md) / [Hooks](../index.md) / OnStop

# Type Alias: OnStop()

> **OnStop** = (`context`) => `unknown`

Defined in: gramio/index.d.ts:760

Type for `onStop` hook

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | { `info`: [`TelegramUser`](../../../interfaces/TelegramUser.md); `plugins`: `string`\[]; } |
| `context.info` | [`TelegramUser`](../../../interfaces/TelegramUser.md) |
| `context.plugins` | `string`\[] |

## Returns

`unknown`

## Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).onStop(
    ({ plugins, info, updatesFrom }) => {
        console.log(`plugin list - ${plugins.join(", ")}`);
        console.log(`bot username is @${info.username}`);
    }
);

bot.start();
bot.stop();
```

[Documentation](https://gramio.dev/hooks/on-stop.html)

---

---
url: 'https://gramio.dev/api/prompt/type-aliases/OnValidateErrorFunction.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / OnValidateErrorFunction

# Type Alias: OnValidateErrorFunction()\<Event, Data, ActionReturn>

> **OnValidateErrorFunction**<`Event`, `Data`, `ActionReturn`> = (`context`, ...`data`) => `any`

Defined in: prompt/index.d.ts:81

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Event` *extends* [`EventsUnion`](EventsUnion.md) | - |
| `Data` | - |
| `ActionReturn` | `never` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`PromptAnswer`](PromptAnswer.md)<`Event`> |
| ...`data` | `IsNever`<`ActionReturn`> *extends* `true` ? \[] : \[`ActionReturn`] |

## Returns

`any`

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/Optional.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Optional

# Type Alias: Optional\<T, K>

> **Optional**<`T`, `K`> = `Pick`<`T`, `Exclude`\<keyof `T`, `K`>> & `{ [P in K]?: T[P] }` & `object`

Defined in: contexts/index.d.ts:216

Make some keys optional

## Type Parameters

| Type Parameter |
| ------ |
| `T` |
| `K` *extends* keyof `T` |

---

---
url: 'https://gramio.dev/api/init-data/type-aliases/Optional.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/init-data/dist](../index.md) / Optional

# Type Alias: Optional\<T>

> **Optional**<`T`> = { \[P in keyof T]: T\[P] | undefined }

Defined in: init-data/index.d.ts:136

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/PostStoryActivePeriod.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / PostStoryActivePeriod

# Type Alias: PostStoryActivePeriod

> **PostStoryActivePeriod** = `21600` | `43200` | `86400` | `172800`

Defined in: @gramio/types/out/params.d.ts:3142

---

---
url: 'https://gramio.dev/api/gramio/namespaces/Hooks/type-aliases/PreRequest.md'
---
[GramIO API Reference](../../../../../index.md) / [gramio/dist](../../../index.md) / [Hooks](../index.md) / PreRequest

# Type Alias: PreRequest()\<Methods>

> **PreRequest**<`Methods`> = (`ctx`) => [`MaybePromise`](../../../type-aliases/MaybePromise.md)<[`PreRequestContext`](PreRequestContext.md)<`Methods`>>

Defined in: gramio/index.d.ts:690

Type for `preRequest` hook

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Methods` *extends* keyof [`APIMethods`](../../../interfaces/APIMethods.md) | keyof [`APIMethods`](../../../interfaces/APIMethods.md) |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`PreRequestContext`](PreRequestContext.md)<`Methods`> |

## Returns

[`MaybePromise`](../../../type-aliases/MaybePromise.md)<[`PreRequestContext`](PreRequestContext.md)<`Methods`>>

## Example

```typescript
import { Bot } from "gramio";

const bot = new Bot(process.env.TOKEN!).preRequest((context) => {
    if (context.method === "sendMessage") {
        context.params.text = "mutate params";
    }

    return context;
});

bot.start();
```

[Documentation](https://gramio.dev/hooks/pre-request.html)

---

---
url: >-
  https://gramio.dev/api/gramio/namespaces/Hooks/type-aliases/PreRequestContext.md
---
[GramIO API Reference](../../../../../index.md) / [gramio/dist](../../../index.md) / [Hooks](../index.md) / PreRequestContext

# Type Alias: PreRequestContext\<Methods>

> **PreRequestContext**<`Methods`> = `AnyTelegramMethod`<`Methods`>

Defined in: gramio/index.d.ts:669

Argument type for [PreRequest](PreRequest.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Methods` *extends* keyof [`APIMethods`](../../../interfaces/APIMethods.md) |

---

---
url: 'https://gramio.dev/api/prompt/type-aliases/PromptAnswer.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / PromptAnswer

# Type Alias: PromptAnswer\<Event, Data>

> **PromptAnswer**<`Event`, `Data`> = `IsNever`<`Data`> *extends* `true` ? [`ContextType`](../../../contexts/dist/type-aliases/ContextType.md)<[`BotLike`](../../../contexts/dist/interfaces/BotLike.md), `Event`> & [`PromptPluginTypes`](../interfaces/PromptPluginTypes.md) : `Data`

Defined in: prompt/index.d.ts:78

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Event` *extends* [`EventsUnion`](EventsUnion.md) | - |
| `Data` | `never` |

---

---
url: 'https://gramio.dev/api/prompt/type-aliases/PromptsType.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / PromptsType

# Type Alias: PromptsType\<Data>

> **PromptsType**<`Data`> = `Map`<`number`, `PromptData`<[`EventsUnion`](EventsUnion.md), `Data`>>

Defined in: prompt/index.d.ts:25

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Data` | `never` |

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/RepostStoryActivePeriod.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / RepostStoryActivePeriod

# Type Alias: RepostStoryActivePeriod

> **RepostStoryActivePeriod** = `21600` | `43200` | `86400` | `172800`

Defined in: @gramio/types/out/params.d.ts:3186

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/Require.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / Require

# Type Alias: Require\<O, K>

> **Require**<`O`, `K`> = `{ [P in K]-?: NonNullable<O[P]> }`

Defined in: contexts/index.d.ts:206

Like `Required<T>` but for specified keys of `T`

## Type Parameters

| Type Parameter |
| ------ |
| `O` |
| `K` *extends* keyof `O` |

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/RequireValue.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / RequireValue

# Type Alias: RequireValue\<O, K, V>

> **RequireValue**<`O`, `K`, `V`> = `Omit`<`O`, `K`> & `{ [P in K]-?: V }`

Defined in: contexts/index.d.ts:212

Like `Require<O, K>` but it sets `V` as the value for `K` values

## Type Parameters

| Type Parameter |
| ------ |
| `O` |
| `K` *extends* keyof `O` |
| `V` |

---

---
url: 'https://gramio.dev/api/composer/type-aliases/RouteHandler.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / RouteHandler

# Type Alias: RouteHandler\<T>

> **RouteHandler**<`T`> = [`Middleware`](Middleware.md)<`T`> | [`Middleware`](Middleware.md)<`T`>\[] | [`Composer`](../classes/Composer.md)<`any`, `any`, `any`, `any`>

Defined in: composer/index.d.ts:135

Route handler: single middleware, array, or Composer instance

## Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `object` |

---

---
url: 'https://gramio.dev/api/callback-data/type-aliases/SafeUnpackResult.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/callback-data/dist](../index.md) / SafeUnpackResult

# Type Alias: SafeUnpackResult\<T>

> **SafeUnpackResult**<`T`> = { `data`: `T`; `success`: `true`; } | { `error`: `Error`; `success`: `false`; }

Defined in: callback-data/index.d.ts:49

## Type Parameters

| Type Parameter |
| ------ |
| `T` |

---

---
url: 'https://gramio.dev/api/scenes/type-aliases/SceneDerivesDefinitions.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / SceneDerivesDefinitions

# Type Alias: SceneDerivesDefinitions\<Params, State, ExitData>

> **SceneDerivesDefinitions**<`Params`, `State`, `ExitData`> = [`DeriveDefinitions`](../../../../gramio/type-aliases/DeriveDefinitions.md) & `object`

Defined in: scenes/index.d.ts:208

## Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `global` | `object` | scenes/index.d.ts:209 |
| `global.scene` | `ReturnType`<*typeof* `getInActiveSceneHandler`> | scenes/index.d.ts:210 |

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Params` | - |
| `State` *extends* [`StateTypesDefault`](StateTypesDefault.md) | - |
| `ExitData` *extends* `Record`<`string`, `unknown`> | `Record`<`string`, `unknown`> |

---

---
url: 'https://gramio.dev/api/scenes/type-aliases/SceneEnterHandler.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / SceneEnterHandler

# Type Alias: SceneEnterHandler()\<Scene>

> **SceneEnterHandler**<`Scene`> = (`scene`, ...`args`) => `Promise`<`void`>

Defined in: scenes/index.d.ts:172

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Scene` *extends* [`AnyScene`](AnyScene.md) | [`AnyScene`](AnyScene.md) |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `scene` | `Scene` |
| ...`args` | `Scene`\[`"~"`]\[`"params"`] *extends* `never` ? \[] : \[`Scene`\[`"~"`]\[`"params"`]] |

## Returns

`Promise`<`void`>

---

---
url: 'https://gramio.dev/api/scenes/type-aliases/ScenesStorage.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / ScenesStorage

# Type Alias: ScenesStorage

> **ScenesStorage** = [`Storage`](../../../storage/dist/interfaces/Storage.md)<`Record`<\`@gramio/scenes:${string | number}\`, [`ScenesStorageData`](../interfaces/ScenesStorageData.md)<`unknown`, `unknown`>>>

Defined in: scenes/index.d.ts:144

---

---
url: 'https://gramio.dev/api/scenes/type-aliases/SceneStepReturn.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / SceneStepReturn

# Type Alias: SceneStepReturn

> **SceneStepReturn** = `object`

Defined in: scenes/index.d.ts:177

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `firstTime` | `boolean` | scenes/index.d.ts:180 |
|  `go` | (`stepId`, `firstTime?`) => `Promise`<`void`> | scenes/index.d.ts:181 |
|  `id` | `number` | scenes/index.d.ts:178 |
|  `next` | () => `Promise`<`void`> | scenes/index.d.ts:182 |
|  `previous` | () => `Promise`<`void`> | scenes/index.d.ts:183 |
|  `previousId` | `number` | scenes/index.d.ts:179 |

---

---
url: 'https://gramio.dev/api/composer/type-aliases/Scope.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / Scope

# Type Alias: Scope

> **Scope** = `"local"` | `"scoped"` | `"global"`

Defined in: composer/index.d.ts:20

Scope level for middleware propagation

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/SendChatActionAction.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendChatActionAction

# Type Alias: SendChatActionAction

> **SendChatActionAction** = `"typing"` | `"upload_photo"` | `"record_video"` | `"upload_video"` | `"record_voice"` | `"upload_voice"` | `"upload_document"` | `"choose_sticker"` | `"find_location"` | `"record_video_note"` | `"upload_video_note"`

Defined in: @gramio/types/out/params.d.ts:1597

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/SendDiceEmoji.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendDiceEmoji

# Type Alias: SendDiceEmoji

> **SendDiceEmoji** = `"🎲"` | `"🎯"` | `"🏀"` | `"⚽"` | `"🎳"` | `"🎰"`

Defined in: @gramio/types/out/params.d.ts:1503

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/SendPollType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SendPollType

# Type Alias: SendPollType

> **SendPollType** = `"quiz"` | `"regular"`

Defined in: @gramio/types/out/params.d.ts:1355

---

---
url: 'https://gramio.dev/api/session/type-aliases/SessionData.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/session/dist](../index.md) / SessionData

# Type Alias: SessionData\<Data, Lazy>

> **SessionData**<`Data`, `Lazy`> = `Lazy` *extends* `true` ? `Promise`<`Data` & `object`> : `Data` & `object`

Defined in: session/index.d.ts:37

Helper type: If Lazy is true, wraps Data in Promise, otherwise returns Data as-is

## Type Parameters

| Type Parameter |
| ------ |
| `Data` |
| `Lazy` *extends* `boolean` |

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/SetStickerSetThumbnailFormat.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SetStickerSetThumbnailFormat

# Type Alias: SetStickerSetThumbnailFormat

> **SetStickerSetThumbnailFormat** = `"static"` | `"animated"` | `"video"`

Defined in: @gramio/types/out/params.d.ts:3868

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/ShouldFollowLanguage.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / ShouldFollowLanguage

# Type Alias: ShouldFollowLanguage\<Language>

> **ShouldFollowLanguage**<`Language`> = `{ [Key in keyof Language]?: Language[Key] }`

Defined in: i18n/index.d.ts:18

## Type Parameters

| Type Parameter |
| ------ |
| `Language` *extends* [`LanguageMap`](../interfaces/LanguageMap.md) |

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/ShouldFollowLanguageStrict.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / ShouldFollowLanguageStrict

# Type Alias: ShouldFollowLanguageStrict\<Language>

> **ShouldFollowLanguageStrict**<`Language`> = `{ [Key in keyof Language]: Language[Key] }`

Defined in: i18n/index.d.ts:21

## Type Parameters

| Type Parameter |
| ------ |
| `Language` *extends* [`LanguageMap`](../interfaces/LanguageMap.md) |

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/SoftString.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / SoftString

# Type Alias: SoftString\<S>

> **SoftString**<`S`> = `string` & `object` | `S`

Defined in: contexts/index.d.ts:204

Permits `string` but gives hints

## Type Parameters

| Type Parameter |
| ------ |
| `S` *extends* `string` |

---

---
url: 'https://gramio.dev/api/i18n/type-aliases/SoftString.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/i18n/dist](../index.md) / SoftString

# Type Alias: SoftString\<Strings>

> **SoftString**<`Strings`> = `Strings` | `object` & `string`

Defined in: i18n/index.d.ts:24

## Type Parameters

| Type Parameter |
| ------ |
| `Strings` |

---

---
url: 'https://gramio.dev/api/scenes/type-aliases/StateTypesDefault.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / StateTypesDefault

# Type Alias: StateTypesDefault

> **StateTypesDefault** = `Record`<`string` | `number`, `any`>

Defined in: scenes/index.d.ts:142

---

---
url: 'https://gramio.dev/api/scenes/type-aliases/StepHandler.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / StepHandler

# Type Alias: StepHandler()\<T, Return>

> **StepHandler**<`T`, `Return`> = (`context`, `next`) => `any`

Defined in: scenes/index.d.ts:207

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` | - |
| `Return` | `any` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | `T` |
| `next` | [`Next`](../../../composer/dist/type-aliases/Next.md) |

## Returns

`any`

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/Stringable.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / Stringable

# Type Alias: Stringable

> **Stringable** = `string` | { `toString`: `string`; }

Defined in: format/formattable-string-BKevNsLk.d.ts:4

Type which contains a string or has the ability to result in a string object

---

---
url: 'https://gramio.dev/api/prompt/type-aliases/Stringable.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / Stringable

# Type Alias: Stringable

> **Stringable** = `string` | [`FormattableString`](../../../../gramio/classes/FormattableString.md)

Defined in: prompt/index.d.ts:24

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/SuppressedAPIMethodParams.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SuppressedAPIMethodParams

# Type Alias: SuppressedAPIMethodParams\<Method>

> **SuppressedAPIMethodParams**<`Method`> = `undefined` *extends* [`APIMethodParams`](APIMethodParams.md)<`Method`> ? [`Suppress`](../interfaces/Suppress.md)<`true`> : [`MaybeSuppressedParams`](MaybeSuppressedParams.md)<`Method`, `true`>

Defined in: gramio/index.d.ts:642

Return method params but with [Suppress](../interfaces/Suppress.md)

## Type Parameters

| Type Parameter |
| ------ |
| `Method` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/SuppressedAPIMethodReturn.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SuppressedAPIMethodReturn

# Type Alias: SuppressedAPIMethodReturn\<Method>

> **SuppressedAPIMethodReturn**<`Method`> = [`MaybeSuppressedReturn`](MaybeSuppressedReturn.md)<`Method`, `true`>

Defined in: gramio/index.d.ts:646

Type that return [Suppressed](../interfaces/Suppress.md) API method ReturnType

## Type Parameters

| Type Parameter |
| ------ |
| `Method` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) |

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/SuppressedAPIMethods.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / SuppressedAPIMethods

# Type Alias: SuppressedAPIMethods\<Methods>

> **SuppressedAPIMethods**<`Methods`> = `{ [APIMethod in Methods]: APIMethodParams<APIMethod> extends undefined ? (params?: Suppress<IsSuppressed>) => Promise<MaybeSuppressedReturn<APIMethod, IsSuppressed>> : undefined extends APIMethodParams<APIMethod> ? (params?: MaybeSuppressedParams<APIMethod, IsSuppressed>) => Promise<MaybeSuppressedReturn<APIMethod, IsSuppressed>> : (params: MaybeSuppressedParams<APIMethod, IsSuppressed>) => Promise<MaybeSuppressedReturn<APIMethod, IsSuppressed>> }`

Defined in: gramio/index.d.ts:648

Map of APIMethods but with [Suppress](../interfaces/Suppress.md)

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Methods` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) | keyof [`APIMethods`](../interfaces/APIMethods.md) |

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramAPIResponse.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramAPIResponse

# Type Alias: TelegramAPIResponse\<Methods>

> **TelegramAPIResponse**<`Methods`> = [`TelegramAPIResponseOk`](../interfaces/TelegramAPIResponseOk.md)<`Methods`> | [`TelegramAPIResponseError`](../interfaces/TelegramAPIResponseError.md)

Defined in: @gramio/types/out/objects.d.ts:8939

The response contains a JSON object, which always has a Boolean field 'ok'.

[Documentation](https://core.telegram.org/bots/api/#making-requests)

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `Methods` *extends* keyof [`APIMethods`](../interfaces/APIMethods.md) | keyof [`APIMethods`](../interfaces/APIMethods.md) |

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramBackgroundFill.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBackgroundFill

# Type Alias: TelegramBackgroundFill

> **TelegramBackgroundFill** = [`TelegramBackgroundFillSolid`](../interfaces/TelegramBackgroundFillSolid.md) | [`TelegramBackgroundFillGradient`](../interfaces/TelegramBackgroundFillGradient.md) | [`TelegramBackgroundFillFreeformGradient`](../interfaces/TelegramBackgroundFillFreeformGradient.md)

Defined in: @gramio/types/out/objects.d.ts:2183

This object describes the way a background is filled based on the selected colors. Currently, it can be one of

* [BackgroundFillSolid](https://core.telegram.org/bots/api#backgroundfillsolid)
* [BackgroundFillGradient](https://core.telegram.org/bots/api#backgroundfillgradient)
* [BackgroundFillFreeformGradient](https://core.telegram.org/bots/api#backgroundfillfreeformgradient)

[Documentation](https://core.telegram.org/bots/api/#backgroundfill)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramBackgroundType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBackgroundType

# Type Alias: TelegramBackgroundType

> **TelegramBackgroundType** = [`TelegramBackgroundTypeFill`](../interfaces/TelegramBackgroundTypeFill.md) | [`TelegramBackgroundTypeWallpaper`](../interfaces/TelegramBackgroundTypeWallpaper.md) | [`TelegramBackgroundTypePattern`](../interfaces/TelegramBackgroundTypePattern.md) | [`TelegramBackgroundTypeChatTheme`](../interfaces/TelegramBackgroundTypeChatTheme.md)

Defined in: @gramio/types/out/objects.d.ts:2254

This object describes the type of a background. Currently, it can be one of

* [BackgroundTypeFill](https://core.telegram.org/bots/api#backgroundtypefill)
* [BackgroundTypeWallpaper](https://core.telegram.org/bots/api#backgroundtypewallpaper)
* [BackgroundTypePattern](https://core.telegram.org/bots/api#backgroundtypepattern)
* [BackgroundTypeChatTheme](https://core.telegram.org/bots/api#backgroundtypechattheme)

[Documentation](https://core.telegram.org/bots/api/#backgroundtype)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramBotCommandScope.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramBotCommandScope

# Type Alias: TelegramBotCommandScope

> **TelegramBotCommandScope** = [`TelegramBotCommandScopeDefault`](../interfaces/TelegramBotCommandScopeDefault.md) | [`TelegramBotCommandScopeAllPrivateChats`](../interfaces/TelegramBotCommandScopeAllPrivateChats.md) | [`TelegramBotCommandScopeAllGroupChats`](../interfaces/TelegramBotCommandScopeAllGroupChats.md) | [`TelegramBotCommandScopeAllChatAdministrators`](../interfaces/TelegramBotCommandScopeAllChatAdministrators.md) | [`TelegramBotCommandScopeChat`](../interfaces/TelegramBotCommandScopeChat.md) | [`TelegramBotCommandScopeChatAdministrators`](../interfaces/TelegramBotCommandScopeChatAdministrators.md) | [`TelegramBotCommandScopeChatMember`](../interfaces/TelegramBotCommandScopeChatMember.md)

Defined in: @gramio/types/out/objects.d.ts:5128

This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:

* [BotCommandScopeDefault](https://core.telegram.org/bots/api#botcommandscopedefault)
* [BotCommandScopeAllPrivateChats](https://core.telegram.org/bots/api#botcommandscopeallprivatechats)
* [BotCommandScopeAllGroupChats](https://core.telegram.org/bots/api#botcommandscopeallgroupchats)
* [BotCommandScopeAllChatAdministrators](https://core.telegram.org/bots/api#botcommandscopeallchatadministrators)
* [BotCommandScopeChat](https://core.telegram.org/bots/api#botcommandscopechat)
* [BotCommandScopeChatAdministrators](https://core.telegram.org/bots/api#botcommandscopechatadministrators)
* [BotCommandScopeChatMember](https://core.telegram.org/bots/api#botcommandscopechatmember)

[Documentation](https://core.telegram.org/bots/api/#botcommandscope)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramChatBoostSource.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatBoostSource

# Type Alias: TelegramChatBoostSource

> **TelegramChatBoostSource** = [`TelegramChatBoostSourcePremium`](../interfaces/TelegramChatBoostSourcePremium.md) | [`TelegramChatBoostSourceGiftCode`](../interfaces/TelegramChatBoostSourceGiftCode.md) | [`TelegramChatBoostSourceGiveaway`](../interfaces/TelegramChatBoostSourceGiveaway.md)

Defined in: @gramio/types/out/objects.d.ts:5340

This object describes the source of a chat boost. It can be one of

* [ChatBoostSourcePremium](https://core.telegram.org/bots/api#chatboostsourcepremium)
* [ChatBoostSourceGiftCode](https://core.telegram.org/bots/api#chatboostsourcegiftcode)
* [ChatBoostSourceGiveaway](https://core.telegram.org/bots/api#chatboostsourcegiveaway)

[Documentation](https://core.telegram.org/bots/api/#chatboostsource)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramChatFullInfoType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatFullInfoType

# Type Alias: TelegramChatFullInfoType

> **TelegramChatFullInfoType** = `"private"` | `"group"` | `"supergroup"` | `"channel"`

Defined in: @gramio/types/out/objects.d.ts:278

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramChatMember.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatMember

# Type Alias: TelegramChatMember

> **TelegramChatMember** = [`TelegramChatMemberOwner`](../interfaces/TelegramChatMemberOwner.md) | [`TelegramChatMemberAdministrator`](../interfaces/TelegramChatMemberAdministrator.md) | [`TelegramChatMemberMember`](../interfaces/TelegramChatMemberMember.md) | [`TelegramChatMemberRestricted`](../interfaces/TelegramChatMemberRestricted.md) | [`TelegramChatMemberLeft`](../interfaces/TelegramChatMemberLeft.md) | [`TelegramChatMemberBanned`](../interfaces/TelegramChatMemberBanned.md)

Defined in: @gramio/types/out/objects.d.ts:3614

This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:

* [ChatMemberOwner](https://core.telegram.org/bots/api#chatmemberowner)
* [ChatMemberAdministrator](https://core.telegram.org/bots/api#chatmemberadministrator)
* [ChatMemberMember](https://core.telegram.org/bots/api#chatmembermember)
* [ChatMemberRestricted](https://core.telegram.org/bots/api#chatmemberrestricted)
* [ChatMemberLeft](https://core.telegram.org/bots/api#chatmemberleft)
* [ChatMemberBanned](https://core.telegram.org/bots/api#chatmemberbanned)

[Documentation](https://core.telegram.org/bots/api/#chatmember)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramChatType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramChatType

# Type Alias: TelegramChatType

> **TelegramChatType** = `"private"` | `"group"` | `"supergroup"` | `"channel"`

Defined in: @gramio/types/out/objects.d.ts:236

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramCurrencies.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramCurrencies

# Type Alias: TelegramCurrencies

> **TelegramCurrencies** = `"AED"` | `"AFN"` | `"ALL"` | `"AMD"` | `"ARS"` | `"AUD"` | `"AZN"` | `"BAM"` | `"BDT"` | `"BGN"` | `"BHD"` | `"BND"` | `"BOB"` | `"BRL"` | `"BYN"` | `"CAD"` | `"CHF"` | `"CLP"` | `"CNY"` | `"COP"` | `"CRC"` | `"CZK"` | `"DKK"` | `"DOP"` | `"DZD"` | `"EGP"` | `"ETB"` | `"EUR"` | `"GBP"` | `"GEL"` | `"GHS"` | `"GTQ"` | `"HKD"` | `"HNL"` | `"HRK"` | `"HUF"` | `"IDR"` | `"ILS"` | `"INR"` | `"IQD"` | `"IRR"` | `"ISK"` | `"JMD"` | `"JOD"` | `"JPY"` | `"KES"` | `"KGS"` | `"KRW"` | `"KZT"` | `"LBP"` | `"LKR"` | `"MAD"` | `"MDL"` | `"MMK"` | `"MNT"` | `"MOP"` | `"MUR"` | `"MVR"` | `"MXN"` | `"MYR"` | `"MZN"` | `"NGN"` | `"NIO"` | `"NOK"` | `"NPR"` | `"NZD"` | `"PAB"` | `"PEN"` | `"PHP"` | `"PKR"` | `"PLN"` | `"PYG"` | `"QAR"` | `"RON"` | `"RSD"` | `"RUB"` | `"SAR"` | `"SEK"` | `"SGD"` | `"SYP"` | `"THB"` | `"TJS"` | `"TRY"` | `"TTD"` | `"TWD"` | `"TZS"` | `"UAH"` | `"UGX"` | `"USD"` | `"UYU"` | `"UZS"` | `"VND"` | `"YER"` | `"ZAR"` | `"XTR"`

Defined in: @gramio/types/out/objects.d.ts:8795

Telegram payments supported currencies. Source: [currencies.json](https://core.telegram.org/bots/payments/currencies.json). See also [supported currencies](https://core.telegram.org/bots/payments/#supported-currencies).

[Documentation](https://core.telegram.org/bots/api/#currencies)

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramEncryptedPassportElementType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramEncryptedPassportElementType

# Type Alias: TelegramEncryptedPassportElementType

> **TelegramEncryptedPassportElementType** = `"personal_details"` | `"passport"` | `"driver_license"` | `"identity_card"` | `"internal_passport"` | `"address"` | `"utility_bill"` | `"bank_statement"` | `"rental_agreement"` | `"passport_registration"` | `"temporary_registration"` | `"phone_number"` | `"email"`

Defined in: @gramio/types/out/objects.d.ts:8342

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramInlineKeyboardButtonStyle.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineKeyboardButtonStyle

# Type Alias: TelegramInlineKeyboardButtonStyle

> **TelegramInlineKeyboardButtonStyle** = `"danger"` | `"success"` | `"primary"`

Defined in: @gramio/types/out/objects.d.ts:3214

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramInlineQueryChatType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryChatType

# Type Alias: TelegramInlineQueryChatType

> **TelegramInlineQueryChatType** = `"sender"` | `"private"` | `"group"` | `"supergroup"` | `"channel"`

Defined in: @gramio/types/out/objects.d.ts:6226

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramInlineQueryResult.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResult

# Type Alias: TelegramInlineQueryResult

> **TelegramInlineQueryResult** = [`TelegramInlineQueryResultCachedAudio`](../interfaces/TelegramInlineQueryResultCachedAudio.md) | [`TelegramInlineQueryResultCachedDocument`](../interfaces/TelegramInlineQueryResultCachedDocument.md) | [`TelegramInlineQueryResultCachedGif`](../interfaces/TelegramInlineQueryResultCachedGif.md) | [`TelegramInlineQueryResultCachedMpeg4Gif`](../interfaces/TelegramInlineQueryResultCachedMpeg4Gif.md) | [`TelegramInlineQueryResultCachedPhoto`](../interfaces/TelegramInlineQueryResultCachedPhoto.md) | [`TelegramInlineQueryResultCachedSticker`](../interfaces/TelegramInlineQueryResultCachedSticker.md) | [`TelegramInlineQueryResultCachedVideo`](../interfaces/TelegramInlineQueryResultCachedVideo.md) | [`TelegramInlineQueryResultCachedVoice`](../interfaces/TelegramInlineQueryResultCachedVoice.md) | [`TelegramInlineQueryResultArticle`](../interfaces/TelegramInlineQueryResultArticle.md) | [`TelegramInlineQueryResultAudio`](../interfaces/TelegramInlineQueryResultAudio.md) | [`TelegramInlineQueryResultContact`](../interfaces/TelegramInlineQueryResultContact.md) | [`TelegramInlineQueryResultGame`](../interfaces/TelegramInlineQueryResultGame.md) | [`TelegramInlineQueryResultDocument`](../interfaces/TelegramInlineQueryResultDocument.md) | [`TelegramInlineQueryResultGif`](../interfaces/TelegramInlineQueryResultGif.md) | [`TelegramInlineQueryResultLocation`](../interfaces/TelegramInlineQueryResultLocation.md) | [`TelegramInlineQueryResultMpeg4Gif`](../interfaces/TelegramInlineQueryResultMpeg4Gif.md) | [`TelegramInlineQueryResultPhoto`](../interfaces/TelegramInlineQueryResultPhoto.md) | [`TelegramInlineQueryResultVenue`](../interfaces/TelegramInlineQueryResultVenue.md) | [`TelegramInlineQueryResultVideo`](../interfaces/TelegramInlineQueryResultVideo.md) | [`TelegramInlineQueryResultVoice`](../interfaces/TelegramInlineQueryResultVoice.md)

Defined in: @gramio/types/out/objects.d.ts:6313

This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:

* [InlineQueryResultCachedAudio](https://core.telegram.org/bots/api#inlinequeryresultcachedaudio)
* [InlineQueryResultCachedDocument](https://core.telegram.org/bots/api#inlinequeryresultcacheddocument)
* [InlineQueryResultCachedGif](https://core.telegram.org/bots/api#inlinequeryresultcachedgif)
* [InlineQueryResultCachedMpeg4Gif](https://core.telegram.org/bots/api#inlinequeryresultcachedmpeg4gif)
* [InlineQueryResultCachedPhoto](https://core.telegram.org/bots/api#inlinequeryresultcachedphoto)
* [InlineQueryResultCachedSticker](https://core.telegram.org/bots/api#inlinequeryresultcachedsticker)
* [InlineQueryResultCachedVideo](https://core.telegram.org/bots/api#inlinequeryresultcachedvideo)
* [InlineQueryResultCachedVoice](https://core.telegram.org/bots/api#inlinequeryresultcachedvoice)
* [InlineQueryResultArticle](https://core.telegram.org/bots/api#inlinequeryresultarticle)
* [InlineQueryResultAudio](https://core.telegram.org/bots/api#inlinequeryresultaudio)
* [InlineQueryResultContact](https://core.telegram.org/bots/api#inlinequeryresultcontact)
* [InlineQueryResultGame](https://core.telegram.org/bots/api#inlinequeryresultgame)
* [InlineQueryResultDocument](https://core.telegram.org/bots/api#inlinequeryresultdocument)
* [InlineQueryResultGif](https://core.telegram.org/bots/api#inlinequeryresultgif)
* [InlineQueryResultLocation](https://core.telegram.org/bots/api#inlinequeryresultlocation)
* [InlineQueryResultMpeg4Gif](https://core.telegram.org/bots/api#inlinequeryresultmpeg4gif)
* [InlineQueryResultPhoto](https://core.telegram.org/bots/api#inlinequeryresultphoto)
* [InlineQueryResultVenue](https://core.telegram.org/bots/api#inlinequeryresultvenue)
* [InlineQueryResultVideo](https://core.telegram.org/bots/api#inlinequeryresultvideo)
* [InlineQueryResultVoice](https://core.telegram.org/bots/api#inlinequeryresultvoice)

[Documentation](https://core.telegram.org/bots/api/#inlinequeryresult)

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramInlineQueryResultDocumentMimeType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultDocumentMimeType

# Type Alias: TelegramInlineQueryResultDocumentMimeType

> **TelegramInlineQueryResultDocumentMimeType** = `"application/pdf"` | `"application/zip"`

Defined in: @gramio/types/out/objects.d.ts:6783

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramInlineQueryResultGifThumbnailMimeType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultGifThumbnailMimeType

# Type Alias: TelegramInlineQueryResultGifThumbnailMimeType

> **TelegramInlineQueryResultGifThumbnailMimeType** = `"image/jpeg"` | `"image/gif"` | `"video/mp4"`

Defined in: @gramio/types/out/objects.d.ts:6451

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramInlineQueryResultMpeg4GifThumbnailMimeType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultMpeg4GifThumbnailMimeType

# Type Alias: TelegramInlineQueryResultMpeg4GifThumbnailMimeType

> **TelegramInlineQueryResultMpeg4GifThumbnailMimeType** = `"image/jpeg"` | `"image/gif"` | `"video/mp4"`

Defined in: @gramio/types/out/objects.d.ts:6526

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramInlineQueryResultVideoMimeType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInlineQueryResultVideoMimeType

# Type Alias: TelegramInlineQueryResultVideoMimeType

> **TelegramInlineQueryResultVideoMimeType** = `"text/html"` | `"video/mp4"`

Defined in: @gramio/types/out/objects.d.ts:6601

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramInputFile.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputFile

# Type Alias: TelegramInputFile

> **TelegramInputFile** = `Blob`

Defined in: @gramio/types/out/objects.d.ts:5892

This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.

[Documentation](https://core.telegram.org/bots/api/#inputfile)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramInputMedia.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputMedia

# Type Alias: TelegramInputMedia

> **TelegramInputMedia** = [`TelegramInputMediaAnimation`](../interfaces/TelegramInputMediaAnimation.md) | [`TelegramInputMediaDocument`](../interfaces/TelegramInputMediaDocument.md) | [`TelegramInputMediaAudio`](../interfaces/TelegramInputMediaAudio.md) | [`TelegramInputMediaPhoto`](../interfaces/TelegramInputMediaPhoto.md) | [`TelegramInputMediaVideo`](../interfaces/TelegramInputMediaVideo.md)

Defined in: @gramio/types/out/objects.d.ts:5648

This object represents the content of a media message to be sent. It should be one of

* [InputMediaAnimation](https://core.telegram.org/bots/api#inputmediaanimation)
* [InputMediaDocument](https://core.telegram.org/bots/api#inputmediadocument)
* [InputMediaAudio](https://core.telegram.org/bots/api#inputmediaaudio)
* [InputMediaPhoto](https://core.telegram.org/bots/api#inputmediaphoto)
* [InputMediaVideo](https://core.telegram.org/bots/api#inputmediavideo)

[Documentation](https://core.telegram.org/bots/api/#inputmedia)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramInputMessageContent.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputMessageContent

# Type Alias: TelegramInputMessageContent

> **TelegramInputMessageContent** = [`TelegramInputTextMessageContent`](../interfaces/TelegramInputTextMessageContent.md) | [`TelegramInputLocationMessageContent`](../interfaces/TelegramInputLocationMessageContent.md) | [`TelegramInputVenueMessageContent`](../interfaces/TelegramInputVenueMessageContent.md) | [`TelegramInputContactMessageContent`](../interfaces/TelegramInputContactMessageContent.md) | [`TelegramInputInvoiceMessageContent`](../interfaces/TelegramInputInvoiceMessageContent.md)

Defined in: @gramio/types/out/objects.d.ts:7456

This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types:

* [InputTextMessageContent](https://core.telegram.org/bots/api#inputtextmessagecontent)
* [InputLocationMessageContent](https://core.telegram.org/bots/api#inputlocationmessagecontent)
* [InputVenueMessageContent](https://core.telegram.org/bots/api#inputvenuemessagecontent)
* [InputContactMessageContent](https://core.telegram.org/bots/api#inputcontactmessagecontent)
* [InputInvoiceMessageContent](https://core.telegram.org/bots/api#inputinvoicemessagecontent)

[Documentation](https://core.telegram.org/bots/api/#inputmessagecontent)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramInputPaidMedia.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputPaidMedia

# Type Alias: TelegramInputPaidMedia

> **TelegramInputPaidMedia** = [`TelegramInputPaidMediaPhoto`](../interfaces/TelegramInputPaidMediaPhoto.md) | [`TelegramInputPaidMediaVideo`](../interfaces/TelegramInputPaidMediaVideo.md)

Defined in: @gramio/types/out/objects.d.ts:5902

This object describes the paid media to be sent. Currently, it can be one of

* [InputPaidMediaPhoto](https://core.telegram.org/bots/api#inputpaidmediaphoto)
* [InputPaidMediaVideo](https://core.telegram.org/bots/api#inputpaidmediavideo)

[Documentation](https://core.telegram.org/bots/api/#inputpaidmedia)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramInputProfilePhoto.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputProfilePhoto

# Type Alias: TelegramInputProfilePhoto

> **TelegramInputProfilePhoto** = [`TelegramInputProfilePhotoStatic`](../interfaces/TelegramInputProfilePhotoStatic.md) | [`TelegramInputProfilePhotoAnimated`](../interfaces/TelegramInputProfilePhotoAnimated.md)

Defined in: @gramio/types/out/objects.d.ts:5974

This object describes a profile photo to set. Currently, it can be one of

* [InputProfilePhotoStatic](https://core.telegram.org/bots/api#inputprofilephotostatic)
* [InputProfilePhotoAnimated](https://core.telegram.org/bots/api#inputprofilephotoanimated)

[Documentation](https://core.telegram.org/bots/api/#inputprofilephoto)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramInputStickerFormat.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputStickerFormat

# Type Alias: TelegramInputStickerFormat

> **TelegramInputStickerFormat** = `"static"` | `"animated"` | `"video"`

Defined in: @gramio/types/out/objects.d.ts:6196

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramInputStoryContent.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramInputStoryContent

# Type Alias: TelegramInputStoryContent

> **TelegramInputStoryContent** = [`TelegramInputStoryContentPhoto`](../interfaces/TelegramInputStoryContentPhoto.md) | [`TelegramInputStoryContentVideo`](../interfaces/TelegramInputStoryContentVideo.md)

Defined in: @gramio/types/out/objects.d.ts:6022

This object describes the content of a story to post. Currently, it can be one of

* [InputStoryContentPhoto](https://core.telegram.org/bots/api#inputstorycontentphoto)
* [InputStoryContentVideo](https://core.telegram.org/bots/api#inputstorycontentvideo)

[Documentation](https://core.telegram.org/bots/api/#inputstorycontent)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramKeyboardButtonStyle.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramKeyboardButtonStyle

# Type Alias: TelegramKeyboardButtonStyle

> **TelegramKeyboardButtonStyle** = `"danger"` | `"success"` | `"primary"`

Defined in: @gramio/types/out/objects.d.ts:3038

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramMaskPositionPoint.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMaskPositionPoint

# Type Alias: TelegramMaskPositionPoint

> **TelegramMaskPositionPoint** = `"forehead"` | `"eyes"` | `"mouth"` | `"chin"`

Defined in: @gramio/types/out/objects.d.ts:6170

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramMaybeInaccessibleMessage.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMaybeInaccessibleMessage

# Type Alias: TelegramMaybeInaccessibleMessage

> **TelegramMaybeInaccessibleMessage** = [`TelegramMessage`](../interfaces/TelegramMessage.md) | [`TelegramInaccessibleMessage`](../interfaces/TelegramInaccessibleMessage.md)

Defined in: @gramio/types/out/objects.d.ts:970

This object describes a message that can be inaccessible to the bot. It can be one of

* [Message](https://core.telegram.org/bots/api#message)
* [InaccessibleMessage](https://core.telegram.org/bots/api#inaccessiblemessage)

[Documentation](https://core.telegram.org/bots/api/#maybeinaccessiblemessage)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramMenuButton.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMenuButton

# Type Alias: TelegramMenuButton

> **TelegramMenuButton** = [`TelegramMenuButtonCommands`](../interfaces/TelegramMenuButtonCommands.md) | [`TelegramMenuButtonWebApp`](../interfaces/TelegramMenuButtonWebApp.md) | [`TelegramMenuButtonDefault`](../interfaces/TelegramMenuButtonDefault.md)

Defined in: @gramio/types/out/objects.d.ts:5282

This object describes the bot's menu button in a private chat. It should be one of

* [MenuButtonCommands](https://core.telegram.org/bots/api#menubuttoncommands)
* [MenuButtonWebApp](https://core.telegram.org/bots/api#menubuttonwebapp)
* [MenuButtonDefault](https://core.telegram.org/bots/api#menubuttondefault)

[Documentation](https://core.telegram.org/bots/api/#menubutton)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramMessageEntityType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMessageEntityType

# Type Alias: TelegramMessageEntityType

> **TelegramMessageEntityType** = `"mention"` | `"hashtag"` | `"cashtag"` | `"bot_command"` | `"url"` | `"email"` | `"phone_number"` | `"bold"` | `"italic"` | `"underline"` | `"strikethrough"` | `"spoiler"` | `"blockquote"` | `"expandable_blockquote"` | `"code"` | `"pre"` | `"text_link"` | `"text_mention"` | `"custom_emoji"` | `"date_time"`

Defined in: @gramio/types/out/objects.d.ts:974

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramMessageOrigin.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramMessageOrigin

# Type Alias: TelegramMessageOrigin

> **TelegramMessageOrigin** = [`TelegramMessageOriginUser`](../interfaces/TelegramMessageOriginUser.md) | [`TelegramMessageOriginHiddenUser`](../interfaces/TelegramMessageOriginHiddenUser.md) | [`TelegramMessageOriginChat`](../interfaces/TelegramMessageOriginChat.md) | [`TelegramMessageOriginChannel`](../interfaces/TelegramMessageOriginChannel.md)

Defined in: @gramio/types/out/objects.d.ts:1222

This object describes the origin of a message. It can be one of

* [MessageOriginUser](https://core.telegram.org/bots/api#messageoriginuser)
* [MessageOriginHiddenUser](https://core.telegram.org/bots/api#messageoriginhiddenuser)
* [MessageOriginChat](https://core.telegram.org/bots/api#messageoriginchat)
* [MessageOriginChannel](https://core.telegram.org/bots/api#messageoriginchannel)

[Documentation](https://core.telegram.org/bots/api/#messageorigin)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramOwnedGift.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramOwnedGift

# Type Alias: TelegramOwnedGift

> **TelegramOwnedGift** = [`TelegramOwnedGiftRegular`](../interfaces/TelegramOwnedGiftRegular.md) | [`TelegramOwnedGiftUnique`](../interfaces/TelegramOwnedGiftUnique.md)

Defined in: @gramio/types/out/objects.d.ts:4919

This object describes a gift received and owned by a user or a chat. Currently, it can be one of

* [OwnedGiftRegular](https://core.telegram.org/bots/api#ownedgiftregular)
* [OwnedGiftUnique](https://core.telegram.org/bots/api#ownedgiftunique)

[Documentation](https://core.telegram.org/bots/api/#ownedgift)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramPaidMedia.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPaidMedia

# Type Alias: TelegramPaidMedia

> **TelegramPaidMedia** = [`TelegramPaidMediaPreview`](../interfaces/TelegramPaidMediaPreview.md) | [`TelegramPaidMediaPhoto`](../interfaces/TelegramPaidMediaPhoto.md) | [`TelegramPaidMediaVideo`](../interfaces/TelegramPaidMediaVideo.md)

Defined in: @gramio/types/out/objects.d.ts:1659

This object describes paid media. Currently, it can be one of

* [PaidMediaPreview](https://core.telegram.org/bots/api#paidmediapreview)
* [PaidMediaPhoto](https://core.telegram.org/bots/api#paidmediaphoto)
* [PaidMediaVideo](https://core.telegram.org/bots/api#paidmediavideo)

[Documentation](https://core.telegram.org/bots/api/#paidmedia)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramPassportElementError.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementError

# Type Alias: TelegramPassportElementError

> **TelegramPassportElementError** = [`TelegramPassportElementErrorDataField`](../interfaces/TelegramPassportElementErrorDataField.md) | [`TelegramPassportElementErrorFrontSide`](../interfaces/TelegramPassportElementErrorFrontSide.md) | [`TelegramPassportElementErrorReverseSide`](../interfaces/TelegramPassportElementErrorReverseSide.md) | [`TelegramPassportElementErrorSelfie`](../interfaces/TelegramPassportElementErrorSelfie.md) | [`TelegramPassportElementErrorFile`](../interfaces/TelegramPassportElementErrorFile.md) | [`TelegramPassportElementErrorFiles`](../interfaces/TelegramPassportElementErrorFiles.md) | [`TelegramPassportElementErrorTranslationFile`](../interfaces/TelegramPassportElementErrorTranslationFile.md) | [`TelegramPassportElementErrorTranslationFiles`](../interfaces/TelegramPassportElementErrorTranslationFiles.md) | [`TelegramPassportElementErrorUnspecified`](../interfaces/TelegramPassportElementErrorUnspecified.md)

Defined in: @gramio/types/out/objects.d.ts:8440

This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:

* [PassportElementErrorDataField](https://core.telegram.org/bots/api#passportelementerrordatafield)
* [PassportElementErrorFrontSide](https://core.telegram.org/bots/api#passportelementerrorfrontside)
* [PassportElementErrorReverseSide](https://core.telegram.org/bots/api#passportelementerrorreverseside)
* [PassportElementErrorSelfie](https://core.telegram.org/bots/api#passportelementerrorselfie)
* [PassportElementErrorFile](https://core.telegram.org/bots/api#passportelementerrorfile)
* [PassportElementErrorFiles](https://core.telegram.org/bots/api#passportelementerrorfiles)
* [PassportElementErrorTranslationFile](https://core.telegram.org/bots/api#passportelementerrortranslationfile)
* [PassportElementErrorTranslationFiles](https://core.telegram.org/bots/api#passportelementerrortranslationfiles)
* [PassportElementErrorUnspecified](https://core.telegram.org/bots/api#passportelementerrorunspecified)

[Documentation](https://core.telegram.org/bots/api/#passportelementerror)

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramPassportElementErrorDataFieldType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorDataFieldType

# Type Alias: TelegramPassportElementErrorDataFieldType

> **TelegramPassportElementErrorDataFieldType** = `"personal_details"` | `"passport"` | `"driver_license"` | `"identity_card"` | `"internal_passport"` | `"address"`

Defined in: @gramio/types/out/objects.d.ts:8451

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramPassportElementErrorFilesType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorFilesType

# Type Alias: TelegramPassportElementErrorFilesType

> **TelegramPassportElementErrorFilesType** = `"utility_bill"` | `"bank_statement"` | `"rental_agreement"` | `"passport_registration"` | `"temporary_registration"`

Defined in: @gramio/types/out/objects.d.ts:8606

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramPassportElementErrorFileType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorFileType

# Type Alias: TelegramPassportElementErrorFileType

> **TelegramPassportElementErrorFileType** = `"utility_bill"` | `"bank_statement"` | `"rental_agreement"` | `"passport_registration"` | `"temporary_registration"`

Defined in: @gramio/types/out/objects.d.ts:8575

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramPassportElementErrorFrontSideType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorFrontSideType

# Type Alias: TelegramPassportElementErrorFrontSideType

> **TelegramPassportElementErrorFrontSideType** = `"passport"` | `"driver_license"` | `"identity_card"` | `"internal_passport"`

Defined in: @gramio/types/out/objects.d.ts:8487

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramPassportElementErrorReverseSideType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorReverseSideType

# Type Alias: TelegramPassportElementErrorReverseSideType

> **TelegramPassportElementErrorReverseSideType** = `"driver_license"` | `"identity_card"`

Defined in: @gramio/types/out/objects.d.ts:8517

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramPassportElementErrorSelfieType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorSelfieType

# Type Alias: TelegramPassportElementErrorSelfieType

> **TelegramPassportElementErrorSelfieType** = `"passport"` | `"driver_license"` | `"identity_card"` | `"internal_passport"`

Defined in: @gramio/types/out/objects.d.ts:8545

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramPassportElementErrorTranslationFilesType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorTranslationFilesType

# Type Alias: TelegramPassportElementErrorTranslationFilesType

> **TelegramPassportElementErrorTranslationFilesType** = `"passport"` | `"driver_license"` | `"identity_card"` | `"internal_passport"` | `"utility_bill"` | `"bank_statement"` | `"rental_agreement"` | `"passport_registration"` | `"temporary_registration"`

Defined in: @gramio/types/out/objects.d.ts:8672

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramPassportElementErrorTranslationFileType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPassportElementErrorTranslationFileType

# Type Alias: TelegramPassportElementErrorTranslationFileType

> **TelegramPassportElementErrorTranslationFileType** = `"passport"` | `"driver_license"` | `"identity_card"` | `"internal_passport"` | `"utility_bill"` | `"bank_statement"` | `"rental_agreement"` | `"passport_registration"` | `"temporary_registration"`

Defined in: @gramio/types/out/objects.d.ts:8637

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramPollType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramPollType

# Type Alias: TelegramPollType

> **TelegramPollType** = `"regular"` | `"quiz"`

Defined in: @gramio/types/out/objects.d.ts:1828

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramReactionType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramReactionType

# Type Alias: TelegramReactionType

> **TelegramReactionType** = [`TelegramReactionTypeEmoji`](../interfaces/TelegramReactionTypeEmoji.md) | [`TelegramReactionTypeCustomEmoji`](../interfaces/TelegramReactionTypeCustomEmoji.md) | [`TelegramReactionTypePaid`](../interfaces/TelegramReactionTypePaid.md)

Defined in: @gramio/types/out/objects.d.ts:4317

This object describes the type of a reaction. Currently, it can be one of

* [ReactionTypeEmoji](https://core.telegram.org/bots/api#reactiontypeemoji)
* [ReactionTypeCustomEmoji](https://core.telegram.org/bots/api#reactiontypecustomemoji)
* [ReactionTypePaid](https://core.telegram.org/bots/api#reactiontypepaid)

[Documentation](https://core.telegram.org/bots/api/#reactiontype)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramReactionTypeEmojiEmoji.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramReactionTypeEmojiEmoji

# Type Alias: TelegramReactionTypeEmojiEmoji

> **TelegramReactionTypeEmojiEmoji** = `"❤"` | `"👍"` | `"👎"` | `"🔥"` | `"🥰"` | `"👏"` | `"😁"` | `"🤔"` | `"🤯"` | `"😱"` | `"🤬"` | `"😢"` | `"🎉"` | `"🤩"` | `"🤮"` | `"💩"` | `"🙏"` | `"👌"` | `"🕊"` | `"🤡"` | `"🥱"` | `"🥴"` | `"😍"` | `"🐳"` | `"❤‍🔥"` | `"🌚"` | `"🌭"` | `"💯"` | `"🤣"` | `"⚡"` | `"🍌"` | `"🏆"` | `"💔"` | `"🤨"` | `"😐"` | `"🍓"` | `"🍾"` | `"💋"` | `"🖕"` | `"😈"` | `"😴"` | `"😭"` | `"🤓"` | `"👻"` | `"👨‍💻"` | `"👀"` | `"🎃"` | `"🙈"` | `"😇"` | `"😨"` | `"🤝"` | `"✍"` | `"🤗"` | `"🫡"` | `"🎅"` | `"🎄"` | `"☃"` | `"💅"` | `"🤪"` | `"🗿"` | `"🆒"` | `"💘"` | `"🙉"` | `"🦄"` | `"😘"` | `"💊"` | `"🙊"` | `"😎"` | `"👾"` | `"🤷‍♂"` | `"🤷"` | `"🤷‍♀"` | `"😡"`

Defined in: @gramio/types/out/objects.d.ts:4322

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramRevenueWithdrawalState.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramRevenueWithdrawalState

# Type Alias: TelegramRevenueWithdrawalState

> **TelegramRevenueWithdrawalState** = [`TelegramRevenueWithdrawalStatePending`](../interfaces/TelegramRevenueWithdrawalStatePending.md) | [`TelegramRevenueWithdrawalStateSucceeded`](../interfaces/TelegramRevenueWithdrawalStateSucceeded.md) | [`TelegramRevenueWithdrawalStateFailed`](../interfaces/TelegramRevenueWithdrawalStateFailed.md)

Defined in: @gramio/types/out/objects.d.ts:8008

This object describes the state of a revenue withdrawal operation. Currently, it can be one of

* [RevenueWithdrawalStatePending](https://core.telegram.org/bots/api#revenuewithdrawalstatepending)
* [RevenueWithdrawalStateSucceeded](https://core.telegram.org/bots/api#revenuewithdrawalstatesucceeded)
* [RevenueWithdrawalStateFailed](https://core.telegram.org/bots/api#revenuewithdrawalstatefailed)

[Documentation](https://core.telegram.org/bots/api/#revenuewithdrawalstate)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramStickerSetStickerType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStickerSetStickerType

# Type Alias: TelegramStickerSetStickerType

> **TelegramStickerSetStickerType** = `"regular"` | `"mask"` | `"custom_emoji"`

Defined in: @gramio/types/out/objects.d.ts:6140

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramStickerType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStickerType

# Type Alias: TelegramStickerType

> **TelegramStickerType** = `"regular"` | `"mask"` | `"custom_emoji"`

Defined in: @gramio/types/out/objects.d.ts:6070

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramStoryAreaType.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramStoryAreaType

# Type Alias: TelegramStoryAreaType

> **TelegramStoryAreaType** = [`TelegramStoryAreaTypeLocation`](../interfaces/TelegramStoryAreaTypeLocation.md) | [`TelegramStoryAreaTypeSuggestedReaction`](../interfaces/TelegramStoryAreaTypeSuggestedReaction.md) | [`TelegramStoryAreaTypeLink`](../interfaces/TelegramStoryAreaTypeLink.md) | [`TelegramStoryAreaTypeWeather`](../interfaces/TelegramStoryAreaTypeWeather.md) | [`TelegramStoryAreaTypeUniqueGift`](../interfaces/TelegramStoryAreaTypeUniqueGift.md)

Defined in: @gramio/types/out/objects.d.ts:4165

Describes the type of a clickable area on a story. Currently, it can be one of

* [StoryAreaTypeLocation](https://core.telegram.org/bots/api#storyareatypelocation)
* [StoryAreaTypeSuggestedReaction](https://core.telegram.org/bots/api#storyareatypesuggestedreaction)
* [StoryAreaTypeLink](https://core.telegram.org/bots/api#storyareatypelink)
* [StoryAreaTypeWeather](https://core.telegram.org/bots/api#storyareatypeweather)
* [StoryAreaTypeUniqueGift](https://core.telegram.org/bots/api#storyareatypeuniquegift)

[Documentation](https://core.telegram.org/bots/api/#storyareatype)

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramSuggestedPostInfoState.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuggestedPostInfoState

# Type Alias: TelegramSuggestedPostInfoState

> **TelegramSuggestedPostInfoState** = `"pending"` | `"approved"` | `"declined"`

Defined in: @gramio/types/out/objects.d.ts:2880

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramSuggestedPostPaidCurrency.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuggestedPostPaidCurrency

# Type Alias: TelegramSuggestedPostPaidCurrency

> **TelegramSuggestedPostPaidCurrency** = `"XTR"` | `"TON"`

Defined in: @gramio/types/out/objects.d.ts:2651

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramSuggestedPostPriceCurrency.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuggestedPostPriceCurrency

# Type Alias: TelegramSuggestedPostPriceCurrency

> **TelegramSuggestedPostPriceCurrency** = `"XTR"` | `"TON"`

Defined in: @gramio/types/out/objects.d.ts:2862

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramSuggestedPostRefundedReason.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramSuggestedPostRefundedReason

# Type Alias: TelegramSuggestedPostRefundedReason

> **TelegramSuggestedPostRefundedReason** = `"post_deleted"` | `"24"` | `"payment_refunded"`

Defined in: @gramio/types/out/objects.d.ts:2677

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramTransactionPartner.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramTransactionPartner

# Type Alias: TelegramTransactionPartner

> **TelegramTransactionPartner** = [`TelegramTransactionPartnerUser`](../interfaces/TelegramTransactionPartnerUser.md) | [`TelegramTransactionPartnerChat`](../interfaces/TelegramTransactionPartnerChat.md) | [`TelegramTransactionPartnerAffiliateProgram`](../interfaces/TelegramTransactionPartnerAffiliateProgram.md) | [`TelegramTransactionPartnerFragment`](../interfaces/TelegramTransactionPartnerFragment.md) | [`TelegramTransactionPartnerTelegramAds`](../interfaces/TelegramTransactionPartnerTelegramAds.md) | [`TelegramTransactionPartnerTelegramApi`](../interfaces/TelegramTransactionPartnerTelegramApi.md) | [`TelegramTransactionPartnerOther`](../interfaces/TelegramTransactionPartnerOther.md)

Defined in: @gramio/types/out/objects.d.ts:8098

This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of

* [TransactionPartnerUser](https://core.telegram.org/bots/api#transactionpartneruser)
* [TransactionPartnerChat](https://core.telegram.org/bots/api#transactionpartnerchat)
* [TransactionPartnerAffiliateProgram](https://core.telegram.org/bots/api#transactionpartneraffiliateprogram)
* [TransactionPartnerFragment](https://core.telegram.org/bots/api#transactionpartnerfragment)
* [TransactionPartnerTelegramAds](https://core.telegram.org/bots/api#transactionpartnertelegramads)
* [TransactionPartnerTelegramApi](https://core.telegram.org/bots/api#transactionpartnertelegramapi)
* [TransactionPartnerOther](https://core.telegram.org/bots/api#transactionpartnerother)

[Documentation](https://core.telegram.org/bots/api/#transactionpartner)

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramTransactionPartnerUserTransactionType.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramTransactionPartnerUserTransactionType

# Type Alias: TelegramTransactionPartnerUserTransactionType

> **TelegramTransactionPartnerUserTransactionType** = `"invoice_payment"` | `"paid_media_payment"` | `"gift_purchase"` | `"premium_purchase"` | `"business_account_transfer"`

Defined in: @gramio/types/out/objects.d.ts:8107

---

---
url: >-
  https://gramio.dev/api/gramio/type-aliases/TelegramUniqueGiftInfoLastResaleCurrency.md
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUniqueGiftInfoLastResaleCurrency

# Type Alias: TelegramUniqueGiftInfoLastResaleCurrency

> **TelegramUniqueGiftInfoLastResaleCurrency** = `"XTR"` | `"TON"`

Defined in: @gramio/types/out/objects.d.ts:4873

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramUniqueGiftInfoOrigin.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUniqueGiftInfoOrigin

# Type Alias: TelegramUniqueGiftInfoOrigin

> **TelegramUniqueGiftInfoOrigin** = `"upgrade"` | `"transfer"` | `"resale"` | `"gifted_upgrade"` | `"offer"`

Defined in: @gramio/types/out/objects.d.ts:4867

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramUniqueGiftModelRarity.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramUniqueGiftModelRarity

# Type Alias: TelegramUniqueGiftModelRarity

> **TelegramUniqueGiftModelRarity** = `"uncommon"` | `"rare"` | `"epic"` | `"legendary"`

Defined in: @gramio/types/out/objects.d.ts:4637

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/TelegramVideoQualityCodec.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / TelegramVideoQualityCodec

# Type Alias: TelegramVideoQualityCodec

> **TelegramVideoQualityCodec** = `"h264"` | `"h265"` | `"av01"`

Defined in: @gramio/types/out/objects.d.ts:1484

---

---
url: 'https://gramio.dev/api/prompt/type-aliases/TimeoutStrategy.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / TimeoutStrategy

# Type Alias: TimeoutStrategy

> **TimeoutStrategy** = `"on-answer"` | `"on-timer"`

Defined in: prompt/index.d.ts:11

---

---
url: 'https://gramio.dev/api/composer/type-aliases/TraceHandler.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / TraceHandler

# Type Alias: TraceHandler()

> **TraceHandler** = (`entry`, `context`) => (`error?`) => `void` | `void`

Defined in: composer/index.d.ts:113

Trace callback invoked on middleware enter; returns cleanup called on exit

## Parameters

| Parameter | Type |
| ------ | ------ |
| `entry` | [`MiddlewareInfo`](../interfaces/MiddlewareInfo.md) |
| `context` | `any` |

## Returns

(`error?`) => `void` | `void`

---

---
url: 'https://gramio.dev/api/prompt/type-aliases/TransformFunction.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / TransformFunction

# Type Alias: TransformFunction()\<Event, Data>

> **TransformFunction**<`Event`, `Data`> = (`context`) => [`MaybePromise`](../../../../gramio/type-aliases/MaybePromise.md)<`Data`>

Defined in: prompt/index.d.ts:80

## Type Parameters

| Type Parameter |
| ------ |
| `Event` *extends* [`EventsUnion`](EventsUnion.md) |
| `Data` |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`PromptAnswer`](PromptAnswer.md)<`Event`, `never`> |

## Returns

[`MaybePromise`](../../../../gramio/type-aliases/MaybePromise.md)<`Data`>

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/tSendAnimation.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / tSendAnimation

# Type Alias: tSendAnimation

> **tSendAnimation** = `id`<`"animation"`, [`SendAnimationParams`](../../../../gramio/interfaces/SendAnimationParams.md)>

Defined in: contexts/index.d.ts:226

This type represent SendAnimationParams and used by Contexts.MessageContext.sendMedia

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/tSendAudio.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / tSendAudio

# Type Alias: tSendAudio

> **tSendAudio** = `id`<`"audio"`, [`SendAudioParams`](../../../../gramio/interfaces/SendAudioParams.md)>

Defined in: contexts/index.d.ts:228

This type represent SendAudioParams and used by Contexts.MessageContext.sendMedia

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/tSendDocument.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / tSendDocument

# Type Alias: tSendDocument

> **tSendDocument** = `id`<`"document"`, [`SendDocumentParams`](../../../../gramio/interfaces/SendDocumentParams.md)>

Defined in: contexts/index.d.ts:230

This type represent SendDocumentParams and used by Contexts.MessageContext.sendMedia

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/tSendMethods.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / tSendMethods

# Type Alias: tSendMethods

> **tSendMethods** = [`tSendAnimation`](tSendAnimation.md) | [`tSendAudio`](tSendAudio.md) | [`tSendDocument`](tSendDocument.md) | [`tSendPhoto`](tSendPhoto.md) | [`tSendSticker`](tSendSticker.md) | [`tSendVideo`](tSendVideo.md) | [`tSendVideoNote`](tSendVideoNote.md) | [`tSendVoice`](tSendVoice.md)

Defined in: contexts/index.d.ts:242

This Union type represent a media that can be sended and used by Contexts.MessageContext.sendMedia

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/tSendPhoto.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / tSendPhoto

# Type Alias: tSendPhoto

> **tSendPhoto** = `id`<`"photo"`, [`SendPhotoParams`](../../../../gramio/interfaces/SendPhotoParams.md)>

Defined in: contexts/index.d.ts:232

This type represent SendPhotoParams and used by Contexts.MessageContext.sendMedia

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/tSendSticker.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / tSendSticker

# Type Alias: tSendSticker

> **tSendSticker** = `id`<`"sticker"`, [`SendStickerParams`](../../../../gramio/interfaces/SendStickerParams.md)>

Defined in: contexts/index.d.ts:234

This type represent SendStickerParams and used by Contexts.MessageContext.sendMedia

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/tSendVideo.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / tSendVideo

# Type Alias: tSendVideo

> **tSendVideo** = `id`<`"video"`, [`SendVideoParams`](../../../../gramio/interfaces/SendVideoParams.md)>

Defined in: contexts/index.d.ts:236

This type represent SendVideoParams and used by Contexts.MessageContext.sendMedia

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/tSendVideoNote.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / tSendVideoNote

# Type Alias: tSendVideoNote

> **tSendVideoNote** = `id`<`"video_note"`, [`SendVideoNoteParams`](../../../../gramio/interfaces/SendVideoNoteParams.md)>

Defined in: contexts/index.d.ts:238

This type represent SendVideoNoteParams and used by Contexts.MessageContext.sendMedia

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/tSendVoice.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / tSendVoice

# Type Alias: tSendVoice

> **tSendVoice** = `id`<`"voice"`, [`SendVoiceParams`](../../../../gramio/interfaces/SendVoiceParams.md)>

Defined in: contexts/index.d.ts:240

This type represent SendVoiceParams and used by Contexts.MessageContext.sendMedia

---

---
url: 'https://gramio.dev/api/scenes/type-aliases/UpdateData.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/scenes/dist](../index.md) / UpdateData

# Type Alias: UpdateData\<T>

> **UpdateData**<`T`> = `object`

Defined in: scenes/index.d.ts:143

## Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`StateTypesDefault`](StateTypesDefault.md) |

---

---
url: 'https://gramio.dev/api/contexts/type-aliases/UpdateName.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / UpdateName

# Type Alias: UpdateName

> **UpdateName** = `Exclude`\<keyof [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md), `"update_id"`> | [`MessageEventName`](MessageEventName.md) | [`CustomEventName`](CustomEventName.md)

Defined in: contexts/index.d.ts:195

Union type of Update names

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/UploadStickerFileStickerFormat.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / UploadStickerFileStickerFormat

# Type Alias: UploadStickerFileStickerFormat

> **UploadStickerFileStickerFormat** = `"static"` | `"animated"` | `"video"`

Defined in: @gramio/types/out/params.d.ts:3696

---

---
url: 'https://gramio.dev/api/prompt/type-aliases/ValidateFunction.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/prompt/dist](../index.md) / ValidateFunction

# Type Alias: ValidateFunction()\<Event>

> **ValidateFunction**<`Event`> = (`context`) => [`MaybePromise`](../../../../gramio/type-aliases/MaybePromise.md)<`boolean`>

Defined in: prompt/index.d.ts:79

## Type Parameters

| Type Parameter |
| ------ |
| `Event` *extends* [`EventsUnion`](EventsUnion.md) |

## Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`PromptAnswer`](PromptAnswer.md)<`Event`, `never`> |

## Returns

[`MaybePromise`](../../../../gramio/type-aliases/MaybePromise.md)<`boolean`>

---

---
url: 'https://gramio.dev/api/init-data/type-aliases/WebAppChatType.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/init-data/dist](../index.md) / WebAppChatType

# Type Alias: WebAppChatType

> **WebAppChatType** = `"sender"` | `"private"` | `"group"` | `"supergroup"` | `"channel"`

Defined in: init-data/index.d.ts:6

Known type of chat.

---

---
url: 'https://gramio.dev/api/init-data/type-aliases/WebAppUser.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/init-data/dist](../index.md) / WebAppUser

# Type Alias: WebAppUser\<isReceiver>

> **WebAppUser**<`isReceiver`> = `object` & `isReceiver` *extends* `true` ? `object` : `object`

Defined in: init-data/index.d.ts:10

This object contains the data of the Mini App user.

## Type Declaration

| Name | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `added_to_attachment_menu?` | `boolean` | True, if this user added the bot to the attachment menu. | init-data/index.d.ts:34 |
| `allows_write_to_pm?` | `boolean` | True, if this user allowed the bot to message them. | init-data/index.d.ts:38 |
| `first_name` | `string` | First name of the user or bot. | init-data/index.d.ts:18 |
| `id` | `number` | A unique identifier for the user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. It has at most 52 significant bits, so a 64-bit integer or a double-precision float type is safe for storing this identifier. | init-data/index.d.ts:14 |
| `is_premium?` | `boolean` | True, if this user is a Telegram Premium user. | init-data/index.d.ts:30 |
| `last_name?` | `string` | Last name of the user or bot. | init-data/index.d.ts:22 |
| `photo_url?` | `string` | URL of the user’s profile photo. The photo can be in .jpeg or .svg formats. Only returned for Mini Apps launched from the attachment menu. | init-data/index.d.ts:43 |
| `username?` | `string` | Username of the user or bot. | init-data/index.d.ts:26 |

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `isReceiver` *extends* `boolean` | `false` |

---

---
url: 'https://gramio.dev/api/gramio/type-aliases/WebhookHandlers.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / WebhookHandlers

# Type Alias: WebhookHandlers

> **WebhookHandlers** = keyof *typeof* `frameworks`

Defined in: gramio/index.d.ts:1670

Union type of webhook handlers name

---

---
url: 'https://gramio.dev/api/composer/type-aliases/WithCtx.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/composer/dist](../index.md) / WithCtx

# Type Alias: WithCtx\<T, TCtx>

> **WithCtx**<`T`, `TCtx`> = `T` *extends* [`ContextCallback`](../interfaces/ContextCallback.md) ? (`ctx`) => `unknown` : `T` *extends* (...`args`) => `any` ? `T` : `T` *extends* `object` ? `{ [K in keyof T]: WithCtx<T[K], TCtx> }` : `T`

Defined in: composer/index.d.ts:45

Recursively replaces all `ContextCallback` occurrences in `T`
with `(ctx: TCtx) => unknown`.

## Type Parameters

| Type Parameter |
| ------ |
| `T` |
| `TCtx` |

---

---
url: 'https://gramio.dev/updates/overview.md'
---
# Update handling

## Start

The `start` method launches the process of receiving updates from Telegram for your bot. Depending on the parameters provided, the bot can use long-polling or webhook to receive events. This method initializes the bot, loads [lazy plugins](/plugins/lazy-load), and calls the [`onStart`](/hooks/on-start) hook.

**Signature:**

```ts
start(options?): Promise<BotInfo>
```

**Parameters:**

* `options` — an object with launch settings:
  * `webhook` — parameters for starting via webhook (`true`, a URL string, or an object with parameters).
  * `longPolling` — parameters for long-polling (for example, timeouts).
  * `dropPendingUpdates` — whether to drop pending updates on start.
  * `allowedUpdates` — a list of update types the bot will receive.
  * `deleteWebhook` — how to handle an existing webhook when starting long-polling.

> \[!IMPORTANT]
>
> **Parameter details:**
>
> * If you set `webhook: true`, GramIO will not attempt to set the webhook itself — it assumes you have already configured it. In this case, the bot will simply start receiving updates via the existing webhook.
>
> * The `deleteWebhook` parameter controls what to do with an existing webhook when starting long-polling:
>   * If `deleteWebhook: true`, the bot will always delete the webhook before starting long-polling.
>   * If `deleteWebhook: "on-conflict-with-polling"`, the webhook will only be deleted if it interferes with starting long-polling (when Telegram responds to `getUpdates` with a conflict error).
>   * If not specified, the default behavior (`on-conflict-with-polling`) is used.

```ts
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN)
    .command("start", (ctx) => ctx.send("Hi!"))
    .onStart(console.log);

await bot.start({
    longPolling: { timeout: 10 },
    dropPendingUpdates: true,
});
```

**How it works:**

* If webhook is not specified, long-polling is started.
* If webhook is specified, the webhook is set up and the bot starts receiving updates via HTTP.
* Calls the [`onStart`](/hooks/on-start) hook.
* You can drop old updates on start.

## Stop

The `stop` method stops receiving updates and gracefully shuts down all internal bot processes. The [`onStop`](/hooks/on-stop) hook is called, and the update queue is cleared.

**Signature:**

```ts
stop(timeout?): Promise<void>
```

**Parameters:**

* `timeout` — the time to wait for the update queue to finish processing (default is 3000 ms).

**Example usage:**

```ts
await bot.stop();
```

**How it works:**

* Stops long-polling or webhook (if it was running).
* Waits for all current updates to finish processing.
* Calls the [`onStop`](/hooks/on-stop) hook.

# Context

## Listen to all events

```ts
bot.use((context, next) => {
    // ...
});
```

## Listen only to specific events

```ts
bot.on("message", (context, next) => {
    // ...
});
// or
bot.on(["message", "callback_query"], (context, next) => {
    // ...
});
```

You can read API Reference for contexts [here](https://jsr.io/@gramio/contexts/doc).

# Context injection

## Derive

`Derive` allows you to inject what's you want to context with access to existing context data and type-safety.
A handler will be called **every** update.

#### Global derive

```ts twoslash
// @errors: 2339 1003
import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .derive((context) => {
        return {
            key: 1,
        };
    })
    .on("message", (context) => {
        context.key;
        //        ^?
    })
    .use((context, next) => {
        context.key;
        //       ^?

        return next();
    })
    .on("callback_query", (context) => {
        context.key;
        //         ^?
    });
```

#### Scoped derive

You can scope the derive to specific **update** (or **updates**) with full type support.

```ts twoslash
// @errors: 2339 1003
import { Bot } from "gramio";

// Simple example
export function findOrRegisterUser(id: number) {
    return {} as Promise<{ id: number; name: string; balance: number }>;
}

const bot = new Bot(process.env.BOT_TOKEN as string)
    .derive(["message", "callback_query"], async (context) => {
        const fromId = context?.from?.id;

        if(!fromId) throw new Error("No from id");

        return {
            fromId,
        }
    })
    .derive("message", async (context) => {
        const user = await findOrRegisterUser(context.fromId);
        //                                              ^?

        return {
            user,
        };
    })
    .on("message", (context) => {
        context.user.;
        //           ^|
        //
    })
    .use((context, next) => {
        if (context.is("message")) context.user;
        //                                  ^?

        return next();
    })
    .on("callback_query", (context) => {
        context.user;
        //         ^?
        context.fromId
        //          ^?
    });
```

## Decorate

With `decorate` you can inject **static values** and it will be injected to contexts **only when `decorate` called** (so it will not evaluate every update).

```ts twoslash
// @errors: 2339

import { Bot } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN as string)
    .decorate("TEST", "hi!! you're cute" as const)
    .decorate({
        key: "value",
        key2: "value",
    })
    .use((context) => {
        context.TEST;
        //         ^?
        //

        context.k;
        //       ^|
    });
```

---

---
url: 'https://gramio.dev/files/media-upload.md'
---

# Media Upload

Class-helper with static methods for file uploading.

## path

Method for uploading Media File by local path.

```ts twoslash
// @errors: 2345
import { BotLike, MessageContext } from "gramio";
import { MediaUpload } from "@gramio/files";

const ctx = {} as InstanceType<MessageContext<BotLike>>;
// ---cut---
ctx.sendDocument(await MediaUpload.path("./package.json"));
// or with filename
ctx.sendDocument(await MediaUpload.path("./package.json", "some-other.json"));
```

If filename not specified, the filename set to filename :)

## url

Method for uploading Media File by URL (also with fetch options).

```ts twoslash
// @errors: 2345
import { BotLike, MessageContext } from "gramio";
import { MediaUpload } from "@gramio/files";

const ctx = {} as InstanceType<MessageContext<BotLike>>;
// ---cut---
ctx.sendPhoto(await MediaUpload.url("https://example.com/cat.png"));
// or with filename
ctx.sendPhoto(
    await MediaUpload.url("https://example.com/cat.png", "cute-cat.png")
);
// or with filename and fetch options (for example headers)
ctx.sendPhoto(
    await MediaUpload.url("https://example.com/cat.png", "cute-cat.png", {
        headers: {
            Authorization: "Bearer gramio",
        },
    })
);
```

If filename not specified, the filename set to last part after `/`.

## buffer

Method for uploading Media File by Buffer or ArrayBuffer.

```ts twoslash
// @errors: 2345
import { BotLike, MessageContext } from "gramio";
import { MediaUpload } from "@gramio/files";

const ctx = {} as InstanceType<MessageContext<BotLike>>;
// ---cut---
const res = await fetch("https://...");

ctx.sendDocument(
    MediaUpload.buffer(await res.arrayBuffer(), "from-buffer.json")
);
```

By default filename is `file.buffer`.

## stream

Method for uploading Media File by Readable stream.

```ts twoslash
// @errors: 2345
import { BotLike, MessageContext } from "gramio";
import { MediaUpload } from "@gramio/files";

// import fs from "node:fs";
// https://github.com/gramiojs/documentation/actions/runs/10424909870/job/28874689592 wtf
const fs = {} as any;

const ctx = {} as InstanceType<MessageContext<BotLike>>;
// ---cut---
ctx.sendDocument(
    await MediaUpload.stream(
        fs.createReadStream("./cute-cat.png"),
        "the-same-cute-cat.png"
    )
);
```

By default filename is `file.stream`.

## text

Method for uploading Media File by text content.

```ts twoslash
// @errors: 2345
import { BotLike, MessageContext } from "gramio";
import { MediaUpload } from "@gramio/files";

const ctx = {} as InstanceType<MessageContext<BotLike>>;
// ---cut---
ctx.sendDocument(MediaUpload.text("GramIO is the best!", "truth.txt"));
```

By default filename is `text.txt`.

---

---
url: 'https://gramio.dev/files/usage-without-gramio.md'
---

# Usage without GramIO

## Write your own type-safe Telegram Bot API wrapper with file uploading support!

```ts twoslash
// @noErrors
import type {
    APIMethods,
    APIMethodParams,
    TelegramAPIResponse,
} from "@gramio/types";
import { isMediaUpload, convertJsonToFormData } from "@gramio/files";

const TBA_BASE_URL = "https://api.telegram.org/bot";
const TOKEN = "";

const api = new Proxy({} as APIMethods, {
    get:
        <T extends keyof APIMethods>(_target: APIMethods, method: T) =>
        async (params: APIMethodParams<T>) => {
            const reqOptions: Parameters<typeof fetch>[1] = {
                method: "POST",
            };

            if (params && isMediaUpload(method, params)) {
                const formData = await convertJsonToFormData(method, params);

                reqOptions.body = formData;
            } else {
                reqOptions.headers = {
                    "Content-Type": "application/json",
                };
                reqOptions.body = JSON.stringify(params);
            }

            const response = await fetch(
                `${TBA_BASE_URL}${TOKEN}/${method}`,
                reqOptions
            );

            const data = (await response.json()) as TelegramAPIResponse;
            if (!data.ok) throw new Error(`Some error in ${method}`);

            return data.result;
        },
});
```

---

---
url: 'https://gramio.dev/guides/for-beginners/3.md'
---

# TypeScript and Keyboard Types

#### What we'll do

* Learn to run TypeScript files using TSX
* Type our `process.env`
* Get to know keyboards and their types
* Learn to respond to regular messages and inline keyboard button clicks

### Running TypeScript Files in Node.js

> Don't be afraid. We're not going to use any special TypeScript features except for type hints right now.

At the time of writing this guide, native support for running TypeScript files is just appearing in Node.js, but it's too early to use it now. So we'll use the excellent "[TSX](https://www.npmjs.com/package/tsx)" library.

First, we need to change the extension of our `index.js` file from JavaScript to TypeScript (i.e., rename it to `index.ts`). Then we can try `tsx` with a simple command:

```bash
npx tsx watch --env-file=.env index.ts
```

Pretty simple! Now let's replace the contents of the `dev` command in our `package.json` file with this command.

### Typing `process.env`

Unfortunately, TypeScript doesn't know what's in our `.env` file, so it can't provide hints. After renaming the file, you should have gotten an error when using the `BOT_TOKEN` environment variable, so let's fix this by adding to the end of the file:

```ts
declare global {
    namespace NodeJS {
        interface ProcessEnv {
            BOT_TOKEN: string;
        }
    }
}
```

Don't worry, what we did is called "declaration merging" - we merged the TypeScript interface type for `process.env` with the values we need in the global scope. For now, you can just accept it as is! The important thing is that the error has disappeared and hints are now available!

```ts twoslash
// @errors: 2580
declare global {
    namespace NodeJS {
        interface ProcessEnv {
            BOT_TOKEN: string;
        }
    }
}
const process = {} as {
    env: {
        BOT_TOKEN: string;
        [key: string]: string | undefined;
    };
};
// ---cut---
process.env.B;
//           ^|
```

### Getting to Know Keyboards and Their Types

> [Keyboard section in the documentation](https://gramio.dev/keyboards/overview)

#### Keyboard

> [Section in the documentation about this keyboard type](https://gramio.dev/keyboards/keyboard)

Let's write a handler for the `/start` command and send a regular keyboard to the user:

```ts
import { Bot, Keyboard } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN)
    .command("start", (context) =>
        context.send("You sent /start", {
            reply_markup: new Keyboard().text("Ping"),
        })
    )
    .hears("Ping", (context) => context.send("Pong"));

bot.start();
```

Let's understand what `new Keyboard().text("Ping")` is:

```ts
new Keyboard().text("Ping");
```

This construct written with the convenient `Keyboard` class hides behind it [some complex things](https://core.telegram.org/bots/api#replykeyboardmarkup) and is actually sent to Telegram like this:

```json
{
    "keyboard": [
        [
            {
                "text": "Ping"
            }
        ]
    ],
    "one_time_keyboard": false,
    "is_persistent": false,
    "selective": false,
    "resize_keyboard": true
}
```

The `hears` method, unlike `command`, listens to all messages and checks if they match the specified text.

#### InlineKeyboard

> [Section in the documentation about this keyboard type](https://gramio.dev/keyboards/inline-keyboard)

Now let's explore the power of `InlineKeyboard`! Let's send an inline keyboard to the user along with "Pong":

```ts
import { Bot, Keyboard, InlineKeyboard } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN)
    .command("start", (context) =>
        context.send("You sent /start", {
            reply_markup: new Keyboard().text("Ping"),
        })
    )
    .hears("Ping", (context) =>
        context.send("Pong", {
            reply_markup: new InlineKeyboard().text("Ping", "ping"),
        })
    );

bot.start();
```

You might wonder what the 2nd argument in the `text` function is - it's the `payload`. Essentially, it's a string that Telegram will return to us when notifying about a clicked button. Let's handle this event. It's called `callback_query` and GramIO has a convenient shorthand for it:

```ts
import { Bot, Keyboard, InlineKeyboard } from "gramio";

const bot = new Bot(process.env.BOT_TOKEN)
    .command("start", (context) =>
        context.send("You sent /start", {
            reply_markup: new Keyboard().text("Ping"),
        })
    )
    .hears("Ping", (context) =>
        context.send("Pong", {
            reply_markup: new InlineKeyboard().text("Ping", "ping"),
        })
    )
    .callbackQuery("ping", async (context) => {
        await context.answer("Pong to your forehead");

        return context.editText("Pong, but from a callback_query!");
    });

bot.start();
```

---

---
url: 'https://gramio.dev/plugins/official/views.md'
---
# Views

[![npm](https://img.shields.io/npm/v/@gramio/views?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/views)
[![npm downloads](https://img.shields.io/npm/dw/@gramio/views?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/@gramio/views)
[![JSR](https://jsr.io/badges/@gramio/views)](https://jsr.io/@gramio/views)
[![JSR Score](https://jsr.io/badges/@gramio/views/score)](https://jsr.io/@gramio/views)

A template system for reusable message views. Auto-detects whether to send a new message or edit the existing one based on context type. Supports programmatic adapters, JSON-driven views with interpolation, filesystem loading, i18n, all keyboard types, and media with URL interpolation.

> \[!WARNING]
> This package is a work in progress. The API may change.

### Installation

::: pm-add @gramio/views
:::

### Usage

```ts
import { Bot, InlineKeyboard } from "gramio";
import { initViewsBuilder } from "@gramio/views";

interface Data {
    user: {
        id: number;
        name: string;
        age: number;
    };
    t: (test: "a" | "b", age: number) => string;
}

const defineView = initViewsBuilder<Data>();

const userView = defineView().render(function (test: "a" | "b") {
    return this.response
        .text(this.t(test, this.user.age))
        .keyboard(new InlineKeyboard().text("test", test));
});

const bot = new Bot(process.env.BOT_TOKEN!)
    .derive(["message", "callback_query"], async (context) => {
        const user = {
            id: context.from.id,
            name: context.from.firstName,
            age: 18,
        };

        const t = (test: "a" | "b", age: number) => test + age;

        return {
            render: defineView.buildRender(context, {
                user,
                t,
            }),
        };
    })
    .on("message", async (context) => {
        return context.render(userView, "a");
    })
    .on("callback_query", async (context) => {
        return context.render(userView, context.data === "a" ? "b" : "a");
    });

bot.start();
```

## Imports

The library uses modular imports to avoid bundling unnecessary dependencies:

```ts
// Main entry — core functionality
import { initViewsBuilder } from "@gramio/views";

// Import adapters separately
import { createJsonAdapter } from "@gramio/views/json";
import { loadJsonViews, loadJsonViewsDir } from "@gramio/views/fs";
import { defineAdapter } from "@gramio/views/define";
```

**Why separate imports?**

* `@gramio/views/fs` includes Node.js filesystem APIs — don't import it in browser/edge environments
* Better tree-shaking and smaller bundles
* Clear separation of concerns

## JSON Adapter

Define views as JSON — useful for CMS-driven or user-editable templates.

```ts
import { initViewsBuilder } from "@gramio/views";
import { createJsonAdapter } from "@gramio/views/json";

const adapter = createJsonAdapter({
    views: {
        welcome: { text: "Hello, {{name}}!" },
        goodbye: { text: "See you later!" },
    },
});

const defineView = initViewsBuilder<Data>().from(adapter);

// Then in a handler:
context.render("welcome", { name: "Alice" });
```

### `reply_markup`, keyboards and media

The `reply_markup` field mirrors the [Telegram Bot API](https://core.telegram.org/bots/api#replykeyboardmarkup) directly. All `{{key}}` interpolation works in button text, `callback_data`, `url`, and `input_field_placeholder`.

**Inline keyboard:**

```json
{
    "welcome": {
        "text": "Hello, {{name}}!",
        "reply_markup": {
            "inline_keyboard": [
                [
                    { "text": "Profile {{name}}", "callback_data": "profile_{{id}}" },
                    { "text": "Help", "callback_data": "help" }
                ],
                [
                    { "text": "Visit", "url": "https://example.com/{{id}}" }
                ]
            ]
        }
    }
}
```

**Reply keyboard:**

```json
{
    "menu": {
        "text": "Choose an option:",
        "reply_markup": {
            "keyboard": [
                [{ "text": "Help" }, { "text": "Settings" }],
                [{ "text": "Share Contact", "request_contact": true }]
            ],
            "resize_keyboard": true,
            "one_time_keyboard": true
        }
    }
}
```

**Remove keyboard / Force reply:**

```json
{ "reply_markup": { "remove_keyboard": true } }
{ "reply_markup": { "force_reply": true, "input_field_placeholder": "Type {{what}}..." } }
```

**Media** (single or group):

```json
{
    "photo_view": {
        "text": "A caption",
        "media": { "type": "photo", "media": "{{photoUrl}}" }
    },
    "gallery": {
        "text": "My photos",
        "media": [
            { "type": "photo", "media": "{{photo1}}" },
            { "type": "photo", "media": "{{photo2}}" }
        ]
    }
}
```

Supported media types: `photo`, `video`, `animation`, `audio`, `document`.

### Globals access with `{{$path}}`

Use `{{$path}}` to reference globals (the values passed to `buildRender`) directly from JSON templates:

```json
{
    "welcome": { "text": "Welcome to {{$appName}}!" },
    "profile": { "text": "{{$user.name}} (age {{$user.age}})" }
}
```

```ts
// globals passed in .derive():
{ appName: "MyBot", user: { name: "Alice", age: 25 } }
```

Mix `$` globals with regular `{{params}}` freely: `"{{$botName}} says hi to {{name}}"`.

### Custom `resolve` callback

For i18n or any custom interpolation logic, pass a `resolve` function to `createJsonAdapter`. It is called for every `{{key}}` (except `$`-prefixed) before falling back to params:

```ts
const adapter = createJsonAdapter<{ t: (key: string) => string }, ViewMap>({
    views: {
        greet: { text: "{{t:hello}}, {{name}}!" },
    },
    resolve: (key, globals) => {
        if (key.startsWith("t:")) return globals.t(key.slice(2));
    },
});
```

If `resolve` returns `undefined`, the key falls through to params. Unresolved keys are preserved as `{{key}}`.

All three sources work everywhere — text, keyboard buttons, media URLs, placeholders:

```json
{ "text": "{{$brand}}: {{t:title}} — {{subtitle}}" }
```

### i18n with adapter factory

For full i18n, write entire JSON templates in each language and pass a **factory function** to `from()`. The factory receives globals and returns the correct adapter per locale:

```
views/
  en/
    welcome.json    → { "text": "Hello, {{name}}!" }
  ru/
    welcome.json    → { "text": "Привет, {{name}}!" }
```

```ts
import { initViewsBuilder } from "@gramio/views";
import { createJsonAdapter } from "@gramio/views/json";
import { loadJsonViewsDir } from "@gramio/views/fs";

const adapters = {
    en: createJsonAdapter({ views: await loadJsonViewsDir("./views/en") }),
    ru: createJsonAdapter({ views: await loadJsonViewsDir("./views/ru") }),
};

const defineView = initViewsBuilder<Data>().from(
    (globals) => adapters[globals.locale]
);

// In .derive(), locale comes from the user context:
bot.derive(["message", "callback_query"], (context) => ({
    render: defineView.buildRender(context, {
        locale: context.from.languageCode ?? "en",
    }),
}));

// render stays the same — adapter is selected automatically:
context.render("welcome", { name: "Alice" });
// → "Привет, Alice!" for Russian users
```

## Loading JSON views from the filesystem

### Single file

One JSON file with multiple views:

```json
// views.json
{
    "welcome": { "text": "Hello, {{name}}!" },
    "goodbye": { "text": "Bye!" }
}
```

```ts
import { createJsonAdapter } from "@gramio/views/json";
import { loadJsonViews } from "@gramio/views/fs";

const views = await loadJsonViews("./views.json");
const adapter = createJsonAdapter({ views });
```

### Directory

Each `.json` file contains multiple named views:

```
views/
  messages.json         → "messages.welcome", "messages.goodbye", "messages.help"
  goods/
    products.json       → "goods.products.list", "goods.products.detail"
```

```json
// messages.json
{
    "welcome": { "text": "Hello, {{name}}!" },
    "goodbye": { "text": "Bye, {{name}}!" },
    "help": { "text": "Need help?" }
}
```

```json
// goods/products.json
{
    "list": { "text": "Product list" },
    "detail": {
        "text": "Product {{name}}",
        "media": { "type": "photo", "media": "{{photo}}" }
    }
}
```

**How it works:**

Each `.json` file must contain an object where:

* **Keys** are view names
* **Values** are view definitions (`{ text?, reply_markup?, media? }`)

The final view key is the file path (dot-separated) + the view name:

```
views/
  main.json             ← { "home": {...}, "about": {...} }
  user/
    profile.json        ← { "view": {...}, "edit": {...} }
```

```ts
import { createJsonAdapter } from "@gramio/views/json";
import { loadJsonViewsDir } from "@gramio/views/fs";

const views = await loadJsonViewsDir("./views");
const adapter = createJsonAdapter({ views });

// Available keys:
// - "main.home"
// - "main.about"
// - "user.profile.view"
// - "user.profile.edit"
```

---

---
url: 'https://gramio.dev/introduction.md'
---

# Why GramIO

GramIO is a **TypeScript-first Telegram Bot API framework** that runs on Node.js, Bun, and Deno. It's built around one idea: the type system should work *for* you, not against you.

Here's what that means in practice.

***

## Types that flow, not types you fight

Most frameworks give you a typed context at entry. GramIO goes further — types **propagate through the entire chain** as you build it.

```ts twoslash
// @filename: db.ts
export const db = {
    getUser: async (id: number) => ({
        name: "Alice",
        role: "admin" as const,
        balance: 42,
    }),
};
// @filename: index.ts
// ---cut---
// @errors: 2339
import { Bot } from "gramio";
import { db } from "./db";

const bot = new Bot(process.env.BOT_TOKEN as string)
    // add to every handler — typed automatically
    .derive(["message"], async (ctx) => ({
        user: await db.getUser(ctx.from!.id),
    }))
    // ctx.user is now fully typed here
    .on("message", (ctx) => {
        ctx.user.role;
        //         ^?
        //
        //
        return ctx.send(`Hi, ${ctx.user.name}!`);
    })
    // ...and here, even for a different event
    // excluded from derive events
    .on("callback_query", (ctx) => ctx.user.balance);
```

No casting. No manual type annotations. No `(ctx as any).user`.

***

## Formatting without `parse_mode`

Telegram formatting with raw HTML or MarkdownV2 is painful — you have to escape everything manually and track `parse_mode`. GramIO uses tagged template literals that produce proper `MessageEntity` objects:

```ts twoslash
import { Bot, format, bold, italic, code, link, spoiler } from "gramio";

const bot = new Bot("");
// ---cut---
bot.command("start", (ctx) =>
    ctx.send(
        format`${bold`Welcome!`} — ${italic("no parse_mode needed")}.
Version: ${code("2.0.0")}
${spoiler`secret`} · ${link("gramio.dev", "https://gramio.dev")}`,
    ),
);
```

No escaping. No `parse_mode: "HTML"`. No broken messages when a username contains `<` or `>`.

***

## Plugins that compose, not configure

Plugins in GramIO use `.extend()` — the same mechanism as everything else. A plugin can add context properties, register handlers, and hook into the lifecycle. And it's all typed end-to-end:

```ts twoslash
import { Bot } from "gramio";
import { scenes, Scene } from "@gramio/scenes";
import { session } from "@gramio/session";

const onboarding = new Scene("onboarding")
    .step("message", (ctx) => {
        if (ctx.scene.step.firstTime) return ctx.send("What's your name?");
        return ctx.scene.update({ name: ctx.text });
    })
    .step("message", (ctx) => ctx.send(`Welcome, ${ctx.scene.state.name}!`));

const bot = new Bot(process.env.BOT_TOKEN as string)
    .extend(session())
    .extend(scenes([onboarding]))
    .command("start", (ctx) => ctx.scene.enter(onboarding));
//                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^
//                              fully typed — ctx.scene comes from the plugin

bot.start();
```

***

## Comparison

| Feature                             | GramIO                        | grammY           | Telegraf        |
| ----------------------------------- | ----------------------------- | ---------------- | --------------- |
| Language                            | TypeScript                    | TypeScript       | TypeScript      |
| Type propagation through middleware | ✅ Full                       | ✅ Full          | ⚠️ Partial      |
| `derive()` with auto-typed context  | ✅                            | ✅               | ❌              |
| Formatting without `parse_mode`     | ✅ Built-in                   | ❌ Manual        | ❌ Manual       |
| Plugin system                       | ✅ `.extend()`                | ✅ Flavors       | ⚠️ Middleware   |
| Multi-runtime (Node/Bun/Deno)       | ✅                            | ✅               | ⚠️ Node focused |
| Code-generated API types            | ✅ Auto-published             | ✅               | ⚠️              |
| Built-in test utilities             | ✅ `@gramio/test`             | ❌               | ❌              |
| Full Telegram API reference         | ✅ `/telegram/`               | ❌               | ❌              |
| Scenes / conversations              | ✅ `@gramio/scenes`           | ✅ Conversations | ✅ Scenes       |
| I18n                                | ✅ `@gramio/i18n` (TS-native) | ✅               | ⚠️              |
| Scaffolding CLI                     | ✅ `create gramio`            | ❌               | ❌              |

***

## Everything is a Composer

`Bot` extends `Composer` — a chainable, type-safe middleware pipeline. Every `.derive()`, `.guard()`, `.on()` returns the updated type. You can extract a `Composer` for any feature, test it in isolation, then `.extend()` it into your bot:

```ts
// src/plugins/index.ts — register once
export const composer = new Composer()
    .extend(session())
    .extend(scenes([onboarding]));

// src/features/profile.ts — fully typed, no Bot needed
export const profileFeature = new Composer()
    .extend(composer) // inherits ctx.session, ctx.scene
    .command("profile", (ctx) => ctx.send(ctx.session.name ?? "anon"));

// src/index.ts — wire together
const bot = new Bot(token).extend(composer).extend(profileFeature);
```

***

## Ready to build?

[Get started →](/get-started)

[Browse plugins →](/plugins/overview)

[Telegram API reference →](/telegram/)

---

---
url: 'https://gramio.dev/ecosystem/wrappergram.md'
---

# Wrappergram

[![npm](https://img.shields.io/npm/v/wrappergram?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/wrappergram)
[![npm downloads](https://img.shields.io/npm/dw/wrappergram?logo=npm\&style=flat\&labelColor=000\&color=3b82f6)](https://www.npmjs.org/package/wrappergram)
[![JSR](https://jsr.io/badges/@gramio/wrappergram)](https://jsr.io/@gramio/wrappergram)
[![JSR Score](https://jsr.io/badges/@gramio/wrappergram/score)](https://jsr.io/@gramio/wrappergram)

A simple, tiny, **code-generated** Telegram Bot API wrapper for TypeScript. Wrappergram provides a minimal, type-safe layer over the Telegram Bot API with file upload support. It is designed for lightweight use cases — browser, serverless environments, or situations where a full framework like [GramIO](/get-started) is overkill.

## Installation

::: pm-add wrappergram
:::

## Quick start

```ts
import { Telegram, getUpdates } from "wrappergram";

const telegram = new Telegram(process.env.BOT_TOKEN as string);

for await (const update of getUpdates(telegram)) {
    if (update.message?.from) {
        await telegram.api.sendMessage({
            chat_id: update.message.from.id,
            text: "Hi! Thanks for the message",
        });
    }
}
```

## API

### `Telegram` class

The main class. Every Telegram Bot API method is available through the type-safe `api` proxy.

```ts
import { Telegram } from "wrappergram";

const telegram = new Telegram("BOT_TOKEN");

// Methods with no required params
const me = await telegram.api.getMe();

// Methods with required params
const response = await telegram.api.sendMessage({
    chat_id: "@gramio_forum",
    text: "Hello, world!",
});

if (!response.ok) console.error("Something went wrong");
else console.log(`Message id: ${response.result.message_id}`);
```

The `api` property returns the **raw Telegram API response**:

```ts
// On success:
{ ok: true, result: T }

// On failure:
{ ok: false, error_code: number, description: string }
```

### Options

```ts
const telegram = new Telegram("BOT_TOKEN", {
    // Custom API server (default: "https://api.telegram.org/bot")
    baseURL: "https://my-custom-server.com/bot",

    // Custom fetch options
    requestOptions: {
        headers: { "X-Custom-Header": "value" },
        signal: AbortSignal.timeout(30000),
    },
});
```

### `getUpdates` — Long polling

An async generator for receiving updates via long polling.

```ts
import { Telegram, getUpdates } from "wrappergram";

const telegram = new Telegram(process.env.BOT_TOKEN as string);

for await (const update of getUpdates(telegram)) {
    console.log(update);
}
```

> \[!WARNING]
> Use `getUpdates` only **once** in your code. Calling it multiple times causes duplicate `getUpdates` requests to the Telegram API.

## File uploads

Wrappergram re-exports `MediaUpload` and `MediaInput` from [`@gramio/files`](https://github.com/gramiojs/files) for file handling.

### `MediaUpload`

```ts
import { Telegram, MediaUpload } from "wrappergram";

const telegram = new Telegram("BOT_TOKEN");

// From local file path
await telegram.api.sendPhoto({
    chat_id: "@gramio_forum",
    photo: MediaUpload.path("./cute-cat.png"),
});

// From URL
await telegram.api.sendPhoto({
    chat_id: 123456,
    photo: MediaUpload.url("https://example.com/image.png"),
});

// From buffer
await telegram.api.sendDocument({
    chat_id: 123456,
    document: MediaUpload.buffer(myBuffer, "data.bin"),
});

// From text content
await telegram.api.sendDocument({
    chat_id: 123456,
    document: MediaUpload.text("Hello world", "hello.txt"),
});
```

### `MediaInput`

Use `MediaInput` for `sendMediaGroup` and similar methods:

```ts
import { Telegram, MediaInput, MediaUpload } from "wrappergram";

const telegram = new Telegram("BOT_TOKEN");

await telegram.api.sendMediaGroup({
    chat_id: 123456,
    media: [
        MediaInput.document(
            MediaUpload.url("https://example.com/file.pdf")
        ),
        MediaInput.document(MediaUpload.path("./package.json")),
    ],
});
```

## Keyboards

For inline and reply keyboards, install [`@gramio/keyboards`](https://github.com/gramiojs/keyboards):

```ts
import { Telegram } from "wrappergram";
import { InlineKeyboard } from "@gramio/keyboards";

const telegram = new Telegram("BOT_TOKEN");

await telegram.api.sendMessage({
    chat_id: "@gramio_forum",
    text: "Hello!",
    reply_markup: new InlineKeyboard().url(
        "GitHub",
        "https://github.com/gramiojs/wrappergram"
    ),
});
```

## Types

Wrappergram re-exports **all** Telegram Bot API types from [`@gramio/types`](https://github.com/gramiojs/types):

```ts
import type { TelegramMessage, TelegramUpdate } from "wrappergram";
```